Public Member Functions | Public Attributes | List of all members
RTC::PeriodicExecutionContext::DFP< Object > Class Template Reference

DFP class. More...

#include <PeriodicExecutionContext.h>

Inheritance diagram for RTC::PeriodicExecutionContext::DFP< Object >:
Inheritance graph
[legend]

Public Member Functions

 DFP (Object obj, ExecutionContextHandle_t id)
 Default constructor. More...
 
void on_aborting (const ECStates &st)
 Function to be invoked when RT-Component occured error. More...
 
void on_activated (const ECStates &st)
 Function to be invoked when RT-Component was activated. More...
 
void on_deactivated (const ECStates &st)
 Function to be invoked when RT-Component was deactivated. More...
 
void on_error (const ECStates &st)
 Function to be invoked while RT-Component is in the error state. More...
 
void on_execute (const ECStates &st)
 Periodic exection function while running RT-Component. More...
 
void on_rate_changed (void)
 Function to be invoked when the execution cycles of ExecutionContext is changed. More...
 
void on_reset (const ECStates &st)
 Function to be invoked when RT-Component is reset. More...
 
void on_shutdown (void)
 Function to be invoked when ExecutionContext stops. More...
 
void on_startup (void)
 Function to be invoked when ExecutionContext starts. More...
 
void on_state_update (const ECStates &st)
 Function to be invoked periodically while RT-Component executes. More...
 
- Public Member Functions inherited from RTC::PeriodicExecutionContext::DFPBase
 DFPBase (RTC::ExecutionContextHandle_t id)
 Constructor. More...
 
virtual ExecContextState get_state (void)
 Get the current state of the target component. More...
 
virtual void worker (void)
 Get the worker to execute the state transition. More...
 
virtual ~DFPBase (void)
 Destructor. More...
 

Public Attributes

bool m_active
 State flag of the target component to manage. More...
 
Object m_obj
 The target component to manage. More...
 
- Public Attributes inherited from RTC::PeriodicExecutionContext::DFPBase
ExecutionContextHandle_t ec_id
 ID of participating ExecutionContext. More...
 
RTC_Utils::StateMachine< ExecContextState, DFPBasem_sm
 The state machine of the target RT-Component to manage. More...
 

Detailed Description

template<class Object>
class RTC::PeriodicExecutionContext::DFP< Object >

DFP class.

Template class to invoke DataFlowParticipant registered in the participant list.

Parameters
ObjectType of the target component to manage
Since
0.4.0

Definition at line 1047 of file PeriodicExecutionContext.h.

Constructor & Destructor Documentation

template<class Object>
RTC::PeriodicExecutionContext::DFP< Object >::DFP ( Object  obj,
ExecutionContextHandle_t  id 
)
inline

Default constructor.

Default constructor

Parameters
objThe target component to manage
idID of participating ExecutionContext

Definition at line 1070 of file PeriodicExecutionContext.h.

Member Function Documentation

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_aborting ( const ECStates st)
inlinevirtual

Function to be invoked when RT-Component occured error.

When the given ExecutionContext transits the Error state, on_aborting of the participation component will be invoked.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1191 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_activated ( const ECStates st)
inlinevirtual

Function to be invoked when RT-Component was activated.

When the given ExecutionContext transits to the Active state, on_activated of the participation component will be invoked. If it fails, the state machine transits to the Errot state.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1137 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_deactivated ( const ECStates st)
inlinevirtual

Function to be invoked when RT-Component was deactivated.

When the given ExecutionContext transits the Deactivate state, on_deactivated of the participation component will be invoked.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1167 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_error ( const ECStates st)
inlinevirtual

Function to be invoked while RT-Component is in the error state.

While the given RT-Component is in the Error state, its on_aborting will be periodically invoked.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1215 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_execute ( const ECStates st)
inlinevirtual

Periodic exection function while running RT-Component.

If the given RT-Component is in the Active state and ExecutionContext is in the Running state, on_execute of the given component will be invoked periodically at the specified execution cycle. If it fails (the return value is other than RTC_OK), its state transits to the Errot state.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1274 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_rate_changed ( void  )
inlinevirtual

Function to be invoked when the execution cycles of ExecutionContext is changed.

When the execution cycle of the participating ExecutionContext is changed, invoke on_rate_changed of the target component will be invoked.

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1336 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_reset ( const ECStates st)
inlinevirtual

Function to be invoked when RT-Component is reset.

When the target RT-Component is reset, invoke on_reset of the target component to manage.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1239 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_shutdown ( void  )
inlinevirtual

Function to be invoked when ExecutionContext stops.

When the given ExecutionContext transits from Running to Stopped, on_shutdown of the participation component will be invoked.

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1110 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_startup ( void  )
inlinevirtual

Function to be invoked when ExecutionContext starts.

When the given ExecutionContext transits from Stopped to Running, on_startup of the participation component will be invoked.

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1090 of file PeriodicExecutionContext.h.

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_state_update ( const ECStates st)
inlinevirtual

Function to be invoked periodically while RT-Component executes.

When the target RT-Component to manage is in the Active state and ExecutionContext is the Running, invoke on_state_update of the target component to manage periodically in specified execution cycle. If it fails (the return value is other than RTC_OK), its state transits to the Errot state.

Parameters
stThe current state of the target RT-Component

Implements RTC::PeriodicExecutionContext::DFPBase.

Definition at line 1309 of file PeriodicExecutionContext.h.

Member Data Documentation

template<class Object>
bool RTC::PeriodicExecutionContext::DFP< Object >::m_active

State flag of the target component to manage.

Definition at line 1357 of file PeriodicExecutionContext.h.

template<class Object>
Object RTC::PeriodicExecutionContext::DFP< Object >::m_obj

The target component to manage.

Definition at line 1348 of file PeriodicExecutionContext.h.


The documentation for this class was generated from the following file:


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Jun 10 2019 14:08:04