Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

RTM::RtcCompositeBase Class Reference

#include <RtcCompositeBase.h>

Inheritance diagram for RTM::RtcCompositeBase:

RTM::RtcBase RTM::RtcSyncComposite List of all members.

Public Member Functions

 RtcCompositeBase ()
 A constructor.

 RtcCompositeBase (RtcManager *manager)
 RtcCompositeBase (CORBA::ORB_ptr &orb, PortableServer::POA_ptr &poa)
virtual RTCProfile * profile ()
 [CORBA interface] Return output port object reference list

virtual RTCConfiguration * configuration ()
virtual RtmRes rtc_add_component (RTCBase_ptr comp)
virtual RtmRes rtc_delete_component (RTCBase_ptr comp)
virtual RtmRes rtc_replace_component (RTCBase_ptr comp1, RTCBase_ptr comp2)
virtual RtmRes rtc_replace_component_by_name (const char *name1, const char *name2)
virtual RTCBaseList * rtc_components ()
virtual RTCBase_ptr rtc_get_component (const char *name)
virtual RtmRes rtc_attach_inport (InPort_ptr in_port)
virtual RtmRes rtc_attach_inport_by_name (RTCBase_ptr comp, const char *name)
virtual RtmRes rtc_detatch_inport (InPort_ptr in_port)
virtual RtmRes rtc_detatch_inport_by_name (const char *name)
virtual RtmRes rtc_attach_outport (OutPort_ptr out_port)
virtual RtmRes rtc_attach_outport_by_name (RTCBase_ptr comp, const char *name)
virtual RtmRes rtc_detatch_outport (OutPort_ptr out_port)
virtual RtmRes rtc_detatch_outport_by_name (const char *name)
virtual int open (void *args)
virtual int svc (void)
virtual RtmRes rtc_start () throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition)
 [CORBA interface] Activate this components' activity

virtual RtmRes rtc_stop () throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition)
 [CORBA interface] Stop this component's activity

virtual RtmRes rtc_reset () throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition)
 [CORBA interface] Go to init() state from error() state

virtual RtmRes rtc_exit () throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition)
 [CORBA interface] Go to term() state from anywhere

virtual RtmRes rtc_kill ()
 [CORBA interface] Go to exiting() state from active() state

virtual RtmRes rtc_worker ()
 [CORBA interface] Main activity function.

virtual OutPort_ptr rtc_state ()
 [CORBA interface] Get activity status OutPort

virtual InPortList * inports ()
 [CORBA interface] Return input port object reference list

virtual InPort_ptr get_inport (const char *name) throw (CORBA::SystemException, RTM::RTComponent::NoSuchName)
 [CORBA interface] Return input port object reference

virtual OutPortList * outports ()
 [CORBA interface] Return output port object reference list

virtual OutPort_ptr get_outport (const char *name) throw (CORBA::SystemException, RTM::RTComponent::NoSuchName)
 [CORBA interface] Return output port object reference

virtual char * instance_id ()
 [CORBA interface] get instance_id

virtual char * implementation_id ()
 [CORBA interface] get implementation_id

virtual char * description ()
 [CORBA interface] get description

virtual char * version ()
 [CORBA interface] get version

virtual char * maker ()
 [CORBA interface] get maker

virtual char * category ()
 [CORBA interface] get category

virtual RtmRes rtc_start_thread ()
 [CORBA interface] Start activity internal thread

virtual RtmRes rtc_suspend_thread ()
 [CORBA interface] Suspend activity internal thread

virtual RtmRes rtc_stop_thread ()
 [CORBA interface] Stop activity internal thread

virtual RtmRes rtc_set_parent (RTCBase_ptr comp)
 [CORBA interface] Set parent component

virtual void init_orb (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
 Initialize this component with ORB and POA pointer.

virtual int close (unsigned long flags)
 Close activity thread.

virtual RTM::RTComponent::ComponentState getState ()
 Get current component state.

virtual void initModuleProfile (RtcModuleProfile prof)
 Initialize RtcModuleProfile.

virtual RtcModuleProfilegetModuleProfile ()
 Get RtcModuleProfile.

virtual string setComponentName (int num)
 Set component name.

bool registerInPort (InPortBase &in_ch)
 Registration of input channel.

bool deleteInPort (InPortBase &in_ch)
 Deletion of InPort.

bool deleteInPortByName (const char *ch_name)
 Deletion of input channel by channel name.

void readAllInPorts ()
 Read all data to InPorts and bound variable.

void finalizeInPorts ()
 Finalize all InPorts.

bool registerOutPort (OutPortBase &out_ch)
 Registration of output channel.

bool deleteOutPort (OutPortBase &out_ch)
 Deletion of output channel.

bool deleteOutPortByName (const char *ch_name)
 Deletion of output channel by channel name.

void writeAllOutPorts ()
 Write all data to OutPorts from bound variables.

void finalizeOutPorts ()
 Finalize all OutPorts.

void appendAlias (const char *alias)
 Register alias of component name.

void appendAlias (const std::string alias)
 Register alias of component name.

std::list< string > getAliases ()
 Get registered aliases of component name.

void setNamingPolicy (NamingPolicy policy)
NamingPolicy getNamingPolicy ()
bool isLongNameEnable ()
bool isAliasEnable ()
void forceExit ()
void finalize ()
 Get registered aliases of component name.

bool isThreadRunning ()

Protected Types

typedef list< RTCBase_ptr
>::iterator 
Components_it
typedef list< InPort_ptr
>::iterator 
InPorts_it
 Input channel list iterator.

typedef list< OutPort_ptr
>::iterator 
OutPorts_it
 Output channel list iterator.

typedef RtmRes(RtcBase::* StateFunc )()
 activity function pointer definition

enum  ThreadStates { UNKNOWN, RUNNING, SUSPEND, STOP }
 activity thread state structure More...


Protected Member Functions

virtual RtmRes rtc_ready_entry ()
 This method will be called once when component enter to Ready state.

virtual RtmRes rtc_ready_do ()
 This method will be called repeatedly when component state is Ready.

virtual RtmRes rtc_ready_exit ()
 This method will be called once when component exit from Ready state.

virtual RtmRes rtc_active_entry ()
 This method will be called once when component enter to Active state.

virtual RtmRes rtc_active_do ()
 This method will be called repeatedly when component state is Active.

virtual RtmRes rtc_active_exit ()
 This method will be called once when component exit from Active state.

virtual RtmRes rtc_error_entry ()
 This method will be called once when component enter to Error state.

virtual RtmRes rtc_error_do ()
 This method will be called repeatedly when component state is Error.

virtual RtmRes rtc_error_exit ()
 This method will be called once when component exit from Error state.

virtual RtmRes rtc_fatal_entry ()
 This method will be called once when component enter to FatalError state.

virtual RtmRes rtc_fatal_do ()
 This method will be called repeatedly when component state is FatalError.

virtual RtmRes rtc_fatal_exit ()
 This method will be called once when component exit from FatalError state.

virtual RtmRes rtc_init_entry ()
 Initializing state This method will be called and move to Ready/Error state immediately.

virtual RtmRes rtc_starting_entry ()
 This method will be called and move to Active state immediately.

virtual RtmRes rtc_stopping_entry ()
 This method will be called and move to Ready state immediately.

virtual RtmRes rtc_aborting_entry ()
 This method will be called and move to Error state immediately.

virtual RtmRes rtc_exiting_entry ()
 This method will be called and terminate component.

bool registerPort (InPortBase &in_ch)
 Registration of input channel.

bool deletePort (InPortBase &in_ch)
 Deletion of input channel.

bool deleteInPortByName (char *ch_name)
 Deletion of input channel by channel name.

bool registerPort (OutPortBase &out_ch)
 Registration of output channel.

bool deletePort (OutPortBase &out_ch)
 Deletion of output channel.

bool deleteOutPortByName (char *ch_name)
 Deletion of output channel by channel name.

RtmRes _check_error (RtmRes result)
 activity error check function

RtmRes _nop ()
 dummy function for activity

RtmRes _rtc_initializing ()
 rtc_init_entry execution function for activity

RtmRes _rtc_ready_entry ()
 rtc_ready_entry execution function for activity

RtmRes _rtc_starting ()
 rtc_starting_entry execution function for activity

RtmRes _rtc_active_entry ()
 rtc_active_entry execution function for activity

RtmRes _rtc_stopping ()
 rtc_stopping_entry execution function for activity

RtmRes _rtc_aborting ()
 rtc_aborting_entry execution function for activity

RtmRes _rtc_error_entry ()
 rtc_error_entry execution function for activity

RtmRes _rtc_fatal_entry ()
 rtc_fatal_entry execution function for activity

RtmRes _rtc_exiting ()
 rtc_exiting_entry execution function for activity

RtmRes _rtc_ready ()
 rtc_ready_do execution function for activity

RtmRes _rtc_active ()
 rtc_active_do execution function for activity

RtmRes _rtc_error ()
 rtc_error_do execution function for activity

RtmRes _rtc_fatal ()
 rtc_fatal_do execution function for activity

RtmRes _rtc_ready_exit ()
 rtc_ready_exit execution function for activity

RtmRes _rtc_active_exit ()
 rtc_active_exit execution function for activity

RtmRes _rtc_error_exit ()
 rtc_error_exit execution function for activity

RtmRes _rtc_fatal_exit ()
 rtc_fatal_exit execution function for activity

void init_state_func_table ()
 initialize activity function table


Protected Attributes

RTCProfile m_Profile
 component profile

RTCConfiguration m_Configuration
Components m_Components
InPorts m_InPorts
 InPort list with mutex.

OutPorts m_OutPorts
 OutPort list with mutex.

CORBA::ORB_ptr m_pORB
 pointer to ORB

PortableServer::POA_ptr m_pPOA
 pointer to POA

RtcManagerm_pManager
 pointer to Manager

RTCBase_var m_Parent
 object reference to parent component

ThreadState m_ThreadState
 activity thread state variable

ComponentStateMtx m_CurrentState
 activity current state varible

ComponentStateMtx m_NextState
 activity next state varible

StateFunc _exit_func [11]
 exit function table of activity

StateFunc _entry_func [11]
 entry function table of activity

StateFunc _do_func [11]
 do function table of activity

TimedState m_TimedState
 Input port flag list activity state variable.

OutPortAny< TimedState > m_StatePort
 activity state OutPort

std::list< string > m_Alias
 Aliases of component name.

NamingPolicy m_NamingPolicy
RtcMedLogbuf m_MedLogbuf
 Logger mediation buffer.

RtcLogStream rtcout
 Logger stream.


Static Protected Attributes

const ComponentState RTC_UNKNOWN = RTM::RTComponent::RTC_UNKNOWN
 Set component category name.

const ComponentState RTC_BORN = RTM::RTComponent::RTC_BORN
const ComponentState RTC_INITIALIZING = RTM::RTComponent::RTC_INITIALIZING
const ComponentState RTC_READY = RTM::RTComponent::RTC_READY
const ComponentState RTC_STARTING = RTM::RTComponent::RTC_STARTING
const ComponentState RTC_ACTIVE = RTM::RTComponent::RTC_ACTIVE
const ComponentState RTC_STOPPING = RTM::RTComponent::RTC_STOPPING
const ComponentState RTC_ABORTING = RTM::RTComponent::RTC_ABORTING
const ComponentState RTC_ERROR = RTM::RTComponent::RTC_ERROR
const ComponentState RTC_FATAL_ERROR = RTM::RTComponent::RTC_FATAL_ERROR
const ComponentState RTC_EXITING = RTM::RTComponent::RTC_EXITING

Member Typedef Documentation

typedef list<RTCBase_ptr>::iterator RTM::RtcCompositeBase::Components_it [protected]
 

typedef list<InPort_ptr>::iterator RTM::RtcCompositeBase::InPorts_it [protected]
 

Input channel list iterator.

Reimplemented from RTM::RtcBase.

typedef list<OutPort_ptr>::iterator RTM::RtcCompositeBase::OutPorts_it [protected]
 

Output channel list iterator.

Reimplemented from RTM::RtcBase.

typedef RtmRes(RtcBase::* RTM::RtcBase::StateFunc)() [protected, inherited]
 

activity function pointer definition


Member Enumeration Documentation

enum RTM::RtcBase::ThreadStates [protected, inherited]
 

activity thread state structure

Enumeration values:
UNKNOWN 
RUNNING 
SUSPEND 
STOP 


Constructor & Destructor Documentation

RTM::RtcCompositeBase::RtcCompositeBase  ) 
 

A constructor.

RTM::RtcCompositeBase::RtcCompositeBase RtcManager manager  ) 
 

RTM::RtcCompositeBase::RtcCompositeBase CORBA::ORB_ptr &  orb,
PortableServer::POA_ptr &  poa
 


Member Function Documentation

RtmRes RTM::RtcBase::_check_error RtmRes  result  )  [protected, inherited]
 

activity error check function

RtmRes RTM::RtcBase::_nop  )  [inline, protected, inherited]
 

dummy function for activity

RtmRes RTM::RtcBase::_rtc_aborting  )  [protected, inherited]
 

rtc_aborting_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_active  )  [protected, inherited]
 

rtc_active_do execution function for activity

RtmRes RTM::RtcBase::_rtc_active_entry  )  [protected, inherited]
 

rtc_active_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_active_exit  )  [protected, inherited]
 

rtc_active_exit execution function for activity

RtmRes RTM::RtcBase::_rtc_error  )  [protected, inherited]
 

rtc_error_do execution function for activity

RtmRes RTM::RtcBase::_rtc_error_entry  )  [protected, inherited]
 

rtc_error_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_error_exit  )  [protected, inherited]
 

rtc_error_exit execution function for activity

RtmRes RTM::RtcBase::_rtc_exiting  )  [protected, inherited]
 

rtc_exiting_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_fatal  )  [protected, inherited]
 

rtc_fatal_do execution function for activity

RtmRes RTM::RtcBase::_rtc_fatal_entry  )  [protected, inherited]
 

rtc_fatal_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_fatal_exit  )  [protected, inherited]
 

rtc_fatal_exit execution function for activity

RtmRes RTM::RtcBase::_rtc_initializing  )  [protected, inherited]
 

rtc_init_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_ready  )  [protected, inherited]
 

rtc_ready_do execution function for activity

RtmRes RTM::RtcBase::_rtc_ready_entry  )  [protected, inherited]
 

rtc_ready_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_ready_exit  )  [protected, inherited]
 

rtc_ready_exit execution function for activity

RtmRes RTM::RtcBase::_rtc_starting  )  [protected, inherited]
 

rtc_starting_entry execution function for activity

RtmRes RTM::RtcBase::_rtc_stopping  )  [protected, inherited]
 

rtc_stopping_entry execution function for activity

void RTM::RtcBase::appendAlias const std::string  alias  )  [inherited]
 

Register alias of component name.

This method register alias of component name. Registered alias will bind to naming server. Context delimiter is "/", id/kind delimiter is "|". If you want to bind your component "MyManipulator0" under a context "Manipulator", you should give an char* argument like "/Manipulator/MyManipulator|rtc". This component will be bound to naming server on this alias.

Parameters:
alias An alias of this component name

void RTM::RtcBase::appendAlias const char *  alias  )  [inherited]
 

Register alias of component name.

This method register alias of component name. Registered alias will bind to naming server. Context delimiter is "/", id/kind delimiter is "|". If you want to bind your component "MyManipulator0" under a context "Manipulator", you should give an char* argument like "/Manipulator/MyManipulator|rtc". This component will be bound to naming server on this alias.

Parameters:
alias An alias of this component name

virtual char* RTM::RtcBase::category  )  [virtual, inherited]
 

[CORBA interface] get category

virtual int RTM::RtcBase::close unsigned long  flags  )  [virtual, inherited]
 

Close activity thread.

close() method is called when activity thread svc() is returned. This method deactivate this object and notify it to manager. ACE_Task class method override.

virtual RTCConfiguration* RTM::RtcCompositeBase::configuration  )  [virtual]
 

bool RTM::RtcBase::deleteInPort InPortBase in_ch  )  [inherited]
 

Deletion of InPort.

"false" is returned when the object of the argument is not registered.

Parameters:
in_ch Input channel object of InPort<T>
Returns:
true/false: "false" will be returned if deletion goes wrong.

bool RTM::RtcBase::deleteInPortByName const char *  ch_name  )  [inherited]
 

Deletion of input channel by channel name.

"false" is returned when the object of the argument is not registered.

Parameters:
ch_name Input channel name
Returns:
true/false: "false" will be returned if deletion goes wrong.

bool RTM::RtcCompositeBase::deleteInPortByName char *  ch_name  )  [protected]
 

Deletion of input channel by channel name.

"false" is returned when the object of the argument is not registered.

Parameters:
ch_name Input channel name
Returns:
true/false: "false" will be returned if deletion goes wrong.

bool RTM::RtcBase::deleteOutPort OutPortBase out_ch  )  [inherited]
 

Deletion of output channel.

"false" is returned when the object of the argument is not registered.

Parameters:
out_ch Output channel object of OutPort<T>
Returns:
true/false: "false" will be returned if deletion goes wrong.

bool RTM::RtcBase::deleteOutPortByName const char *  ch_name  )  [inherited]
 

Deletion of output channel by channel name.

"false" is returned when the object of the argument is not registered.

Parameters:
ch_name Output channel name
Returns:
true/false: "false" will be returned if deletion goes wrong.

bool RTM::RtcCompositeBase::deleteOutPortByName char *  ch_name  )  [protected]
 

Deletion of output channel by channel name.

"false" is returned when the object of the argument is not registered.

Parameters:
ch_name Output channel name
Returns:
true/false: "false" will be returned if deletion goes wrong.

bool RTM::RtcCompositeBase::deletePort OutPortBase out_ch  )  [protected]
 

Deletion of output channel.

"false" is returned when the object of the argument is not registered.

Parameters:
out_ch Output channel object of OutPort<T>
Returns:
true/false: "false" will be returned if deletion goes wrong.

Reimplemented from RTM::RtcBase.

bool RTM::RtcCompositeBase::deletePort InPortBase in_ch  )  [protected]
 

Deletion of input channel.

"false" is returned when the object of the argument is not registered.

Parameters:
in_ch Input channel object of InPort<T>
Returns:
true/false: "false" will be returned if deletion goes wrong.

Reimplemented from RTM::RtcBase.

virtual char* RTM::RtcBase::description  )  [virtual, inherited]
 

[CORBA interface] get description

void RTM::RtcBase::finalize  )  [inherited]
 

Get registered aliases of component name.

void RTM::RtcBase::finalizeInPorts  )  [inherited]
 

Finalize all InPorts.

Finalize all registered InPorts and deactivate as a CORBA objects.

void RTM::RtcBase::finalizeOutPorts  )  [inherited]
 

Finalize all OutPorts.

Finalize all registered OutPorts and deactivate as a CORBA objects.

void RTM::RtcBase::forceExit  )  [inherited]
 

virtual InPort_ptr RTM::RtcBase::get_inport const char *  name  )  throw (CORBA::SystemException, RTM::RTComponent::NoSuchName) [virtual, inherited]
 

[CORBA interface] Return input port object reference

Parameters:
name InPort name

virtual OutPort_ptr RTM::RtcBase::get_outport const char *  name  )  throw (CORBA::SystemException, RTM::RTComponent::NoSuchName) [virtual, inherited]
 

[CORBA interface] Return output port object reference

Parameters:
name OutPort name

std::list<string> RTM::RtcBase::getAliases  )  [inherited]
 

Get registered aliases of component name.

virtual RtcModuleProfile& RTM::RtcBase::getModuleProfile  )  [inline, virtual, inherited]
 

Get RtcModuleProfile.

Get RtcModuleProfile

NamingPolicy RTM::RtcBase::getNamingPolicy  )  [inherited]
 

virtual RTM::RTComponent::ComponentState RTM::RtcBase::getState  )  [virtual, inherited]
 

Get current component state.

virtual char* RTM::RtcBase::implementation_id  )  [virtual, inherited]
 

[CORBA interface] get implementation_id

virtual void RTM::RtcBase::init_orb CORBA::ORB_ptr  orb,
PortableServer::POA_ptr  poa
[virtual, inherited]
 

Initialize this component with ORB and POA pointer.

Parameters:
orb pointer to ORB
poa pointer to POA

void RTM::RtcBase::init_state_func_table  )  [protected, inherited]
 

initialize activity function table

virtual void RTM::RtcBase::initModuleProfile RtcModuleProfile  prof  )  [virtual, inherited]
 

Initialize RtcModuleProfile.

Parameters:
RtcModuleProfile module profile

virtual InPortList* RTM::RtcBase::inports  )  [virtual, inherited]
 

[CORBA interface] Return input port object reference list

virtual char* RTM::RtcBase::instance_id  )  [virtual, inherited]
 

[CORBA interface] get instance_id

bool RTM::RtcBase::isAliasEnable  )  [inherited]
 

bool RTM::RtcBase::isLongNameEnable  )  [inherited]
 

bool RTM::RtcBase::isThreadRunning  )  [inherited]
 

virtual char* RTM::RtcBase::maker  )  [virtual, inherited]
 

[CORBA interface] get maker

virtual int RTM::RtcCompositeBase::open void *  args  )  [inline, virtual]
 

------------------------------------------------------------ Start activity ACE_Task class method over ride. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual OutPortList* RTM::RtcBase::outports  )  [virtual, inherited]
 

[CORBA interface] Return output port object reference list

virtual RTCProfile* RTM::RtcCompositeBase::profile  )  [virtual]
 

[CORBA interface] Return output port object reference list

Reimplemented from RTM::RtcBase.

void RTM::RtcBase::readAllInPorts  )  [inherited]
 

Read all data to InPorts and bound variable.

Invoke InPort::read() to all registered InPorts.

bool RTM::RtcBase::registerInPort InPortBase in_ch  )  [inherited]
 

Registration of input channel.

Duplication of a name of input channel is not allowed. "false" will be returned when there is duplication of a name.

Parameters:
in_ch Input channel object of InPort<T>
Returns:
true/false: "false" will be returned if registration goes wrong.

bool RTM::RtcBase::registerOutPort OutPortBase out_ch  )  [inherited]
 

Registration of output channel.

Duplication of a name of output channel is not allowed. "false" will be returned when there is duplication of a name.

Parameters:
out_ch Output channel object of OutPort<T>
Returns:
true/false: "false" will be returned if registration goes wrong.

bool RTM::RtcCompositeBase::registerPort OutPortBase out_ch  )  [protected]
 

Registration of output channel.

Duplication of a name of output channel is not allowed. "false" will be returned when there is duplication of a name.

Parameters:
out_ch Output channel object of OutPort<T>
Returns:
true/false: "false" will be returned if registration goes wrong.

Reimplemented from RTM::RtcBase.

bool RTM::RtcCompositeBase::registerPort InPortBase in_ch  )  [protected]
 

Registration of input channel.

Duplication of a name of input channel is not allowed. "false" will be returned when there is duplication of a name.

Parameters:
in_ch Input channel object of InPort<T>
Returns:
true/false: "false" will be returned if registration goes wrong.

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_aborting_entry  )  [inline, protected, virtual]
 

This method will be called and move to Error state immediately.

Aborting state. entry: aborting() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_active_do  )  [inline, protected, virtual]
 

This method will be called repeatedly when component state is Active.

do: active() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_active_entry  )  [inline, protected, virtual]
 

This method will be called once when component enter to Active state.

entry: active() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_active_exit  )  [inline, protected, virtual]
 

This method will be called once when component exit from Active state.

exit: active method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_add_component RTCBase_ptr  comp  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Add child component. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_attach_inport InPort_ptr  in_port  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Attach a InPort to composit component's InPort ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_attach_inport_by_name RTCBase_ptr  comp,
const char *  name
[virtual]
 

------------------------------------------------------------ [CORBA interface] Attach a InPort to composit component's InPort by owner component's object reference and its port name. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_attach_outport OutPort_ptr  out_port  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Attach a OutPort to composit component's OutPort ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_attach_outport_by_name RTCBase_ptr  comp,
const char *  name
[virtual]
 

------------------------------------------------------------ [CORBA interface] Attach a OutPort to composit component's OutPort by owner component's object reference and its port name. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RTCBaseList* RTM::RtcCompositeBase::rtc_components  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Get registered child components list. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_delete_component RTCBase_ptr  comp  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Delete child component. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_detatch_inport InPort_ptr  in_port  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Detatch a InPort by InPort's object reference. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_detatch_inport_by_name const char *  name  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Detach a InPort by InPort's name ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_detatch_outport OutPort_ptr  out_port  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Detatch a OutPort by OutPort's object reference. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_detatch_outport_by_name const char *  name  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Detach a OutPort by OutPort's name ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_error_do  )  [inline, protected, virtual]
 

This method will be called repeatedly when component state is Error.

do: error() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_error_entry  )  [inline, protected, virtual]
 

This method will be called once when component enter to Error state.

entry: error() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_error_exit  )  [inline, protected, virtual]
 

This method will be called once when component exit from Error state.

exit: error() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcBase::rtc_exit  )  throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition) [virtual, inherited]
 

[CORBA interface] Go to term() state from anywhere

virtual RtmRes RTM::RtcCompositeBase::rtc_exiting_entry  )  [inline, protected, virtual]
 

This method will be called and terminate component.

Exiting state. entry: exiting() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_fatal_do  )  [inline, protected, virtual]
 

This method will be called repeatedly when component state is FatalError.

do: fatal() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_fatal_entry  )  [inline, protected, virtual]
 

This method will be called once when component enter to FatalError state.

entry: fatal() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_fatal_exit  )  [inline, protected, virtual]
 

This method will be called once when component exit from FatalError state.

exit: fatal() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RTCBase_ptr RTM::RtcCompositeBase::rtc_get_component const char *  name  )  [virtual]
 

------------------------------------------------------------ [CORBA interface] Get a registered child component. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_init_entry  )  [inline, protected, virtual]
 

Initializing state This method will be called and move to Ready/Error state immediately.

Initializing state. entry: initializing() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcBase::rtc_kill  )  [virtual, inherited]
 

[CORBA interface] Go to exiting() state from active() state

virtual RtmRes RTM::RtcCompositeBase::rtc_ready_do  )  [inline, protected, virtual]
 

This method will be called repeatedly when component state is Ready.

do: ready() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_ready_entry  )  [inline, protected, virtual]
 

This method will be called once when component enter to Ready state.

entry: ready() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_ready_exit  )  [inline, protected, virtual]
 

This method will be called once when component exit from Ready state.

exit: ready method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcCompositeBase::rtc_replace_component RTCBase_ptr  comp1,
RTCBase_ptr  comp2
[virtual]
 

------------------------------------------------------------ [CORBA interface] Replace child components ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcCompositeBase::rtc_replace_component_by_name const char *  name1,
const char *  name2
[virtual]
 

------------------------------------------------------------ [CORBA interface] Replace child components by component name ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

virtual RtmRes RTM::RtcBase::rtc_reset  )  throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition) [virtual, inherited]
 

[CORBA interface] Go to init() state from error() state

virtual RtmRes RTM::RtcBase::rtc_set_parent RTCBase_ptr  comp  )  [virtual, inherited]
 

[CORBA interface] Set parent component

virtual RtmRes RTM::RtcBase::rtc_start  )  throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition) [virtual, inherited]
 

[CORBA interface] Activate this components' activity

virtual RtmRes RTM::RtcBase::rtc_start_thread  )  [virtual, inherited]
 

[CORBA interface] Start activity internal thread

virtual RtmRes RTM::RtcCompositeBase::rtc_starting_entry  )  [inline, protected, virtual]
 

This method will be called and move to Active state immediately.

Starting state. entry: starting() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual OutPort_ptr RTM::RtcBase::rtc_state  )  [virtual, inherited]
 

[CORBA interface] Get activity status OutPort

virtual RtmRes RTM::RtcBase::rtc_stop  )  throw (CORBA::SystemException, RTM::RTComponent::IllegalTransition) [virtual, inherited]
 

[CORBA interface] Stop this component's activity

virtual RtmRes RTM::RtcBase::rtc_stop_thread  )  [virtual, inherited]
 

[CORBA interface] Stop activity internal thread

virtual RtmRes RTM::RtcCompositeBase::rtc_stopping_entry  )  [inline, protected, virtual]
 

This method will be called and move to Ready state immediately.

Stopping state. entry: stopping() method.

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual RtmRes RTM::RtcBase::rtc_suspend_thread  )  [virtual, inherited]
 

[CORBA interface] Suspend activity internal thread

virtual RtmRes RTM::RtcBase::rtc_worker  )  [virtual, inherited]
 

[CORBA interface] Main activity function.

Called from activity thread periodically.

virtual string RTM::RtcBase::setComponentName int  num  )  [virtual, inherited]
 

Set component name.

Parameters:
num instance number of this component

void RTM::RtcBase::setNamingPolicy NamingPolicy  policy  )  [inherited]
 

virtual int RTM::RtcCompositeBase::svc void   )  [inline, virtual]
 

------------------------------------------------------------ Run by a daemon thread to handle deferred processing ACE_Task class method over ride. ------------------------------------------------------------

Reimplemented from RTM::RtcBase.

Reimplemented in RTM::RtcSyncComposite.

virtual char* RTM::RtcBase::version  )  [virtual, inherited]
 

[CORBA interface] get version

void RTM::RtcBase::writeAllOutPorts  )  [inherited]
 

Write all data to OutPorts from bound variables.

Invoke OutPort::write() to all registered OutPorts.


Member Data Documentation

StateFunc RTM::RtcBase::_do_func[11] [protected, inherited]
 

do function table of activity

StateFunc RTM::RtcBase::_entry_func[11] [protected, inherited]
 

entry function table of activity

StateFunc RTM::RtcBase::_exit_func[11] [protected, inherited]
 

exit function table of activity

std::list<string> RTM::RtcBase::m_Alias [protected, inherited]
 

Aliases of component name.

Components RTM::RtcCompositeBase::m_Components [protected]
 

RTCConfiguration RTM::RtcCompositeBase::m_Configuration [protected]
 

ComponentStateMtx RTM::RtcBase::m_CurrentState [protected, inherited]
 

activity current state varible

InPorts RTM::RtcCompositeBase::m_InPorts [protected]
 

InPort list with mutex.

Reimplemented from RTM::RtcBase.

RtcMedLogbuf RTM::RtcBase::m_MedLogbuf [protected, inherited]
 

Logger mediation buffer.

NamingPolicy RTM::RtcBase::m_NamingPolicy [protected, inherited]
 

ComponentStateMtx RTM::RtcBase::m_NextState [protected, inherited]
 

activity next state varible

OutPorts RTM::RtcCompositeBase::m_OutPorts [protected]
 

OutPort list with mutex.

Reimplemented from RTM::RtcBase.

RTCBase_var RTM::RtcBase::m_Parent [protected, inherited]
 

object reference to parent component

RtcManager* RTM::RtcBase::m_pManager [protected, inherited]
 

pointer to Manager

CORBA::ORB_ptr RTM::RtcBase::m_pORB [protected, inherited]
 

pointer to ORB

PortableServer::POA_ptr RTM::RtcBase::m_pPOA [protected, inherited]
 

pointer to POA

RTCProfile RTM::RtcCompositeBase::m_Profile [protected]
 

component profile

Reimplemented from RTM::RtcBase.

OutPortAny<TimedState> RTM::RtcBase::m_StatePort [protected, inherited]
 

activity state OutPort

ThreadState RTM::RtcBase::m_ThreadState [protected, inherited]
 

activity thread state variable

TimedState RTM::RtcBase::m_TimedState [protected, inherited]
 

Input port flag list activity state variable.

const ComponentState RTM::RtcCompositeBase::RTC_ABORTING = RTM::RTComponent::RTC_ABORTING [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_ACTIVE = RTM::RTComponent::RTC_ACTIVE [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_BORN = RTM::RTComponent::RTC_BORN [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_ERROR = RTM::RTComponent::RTC_ERROR [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_EXITING = RTM::RTComponent::RTC_EXITING [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_FATAL_ERROR = RTM::RTComponent::RTC_FATAL_ERROR [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_INITIALIZING = RTM::RTComponent::RTC_INITIALIZING [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_READY = RTM::RTComponent::RTC_READY [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_STARTING = RTM::RTComponent::RTC_STARTING [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_STOPPING = RTM::RTComponent::RTC_STOPPING [static, protected]
 

const ComponentState RTM::RtcCompositeBase::RTC_UNKNOWN = RTM::RTComponent::RTC_UNKNOWN [static, protected]
 

Set component category name.

RtcLogStream RTM::RtcBase::rtcout [protected, inherited]
 

Logger stream.


The documentation for this class was generated from the following file:
Generated on Wed Apr 6 14:22:23 2005 for OpenRTM by doxygen 1.3.6