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

RTM::RTCBase Interface Reference

RTCBase interface. More...

import "RTCBase.idl";

Inheritance diagram for RTM::RTCBase:

RTM::RTComponent List of all members.

Public Types

typedef short ComponentState
 Component activity state.


Public Member Functions

RtmRes rtc_ready_entry ()
 entry: ready() method.

RtmRes rtc_ready_do ()
 do: ready() method.

RtmRes rtc_ready_exit ()
 exit: ready() method.

RtmRes rtc_active_entry ()
 entry: active() method.

RtmRes rtc_active_do ()
 do: active() method.

RtmRes rtc_active_exit ()
 exit: active() method.

RtmRes rtc_error_entry ()
 entry: error() method.

RtmRes rtc_error_do ()
 do: ready() method.

RtmRes rtc_error_exit ()
 exit: error() method.

RtmRes rtc_fatal_entry ()
 entry: fatal() method.

RtmRes rtc_fatal_do ()
 do: fatal() method.

RtmRes rtc_fatal_exit ()
 exit: fatal() method.

RtmRes rtc_init_entry ()
 entry: ready() method.

RtmRes rtc_starting_entry ()
 entry: starting() method.

RtmRes rtc_stopping_entry ()
 entry: stopping() method.

RtmRes rtc_aborting_entry ()
 entry: aborting() method.

RtmRes rtc_exiting_entry ()
 entry: exiting() method.

RtmRes rtc_stop_thread ()
 Start activity internal thread.

RtmRes rtc_start_thread ()
 Stop activity internal thread.

RtmRes rtc_set_parent (in RTCBase comp)
 Set parent component.

RtmRes rtc_add_component (in RTCBase comp)
 Set child component.

RtmRes rtc_delete_component (in RTCBase comp)
 Delete child component.

RtmRes rtc_replace_component (in RTCBase comp1, in RTCBase comp2)
 Replace two child components.

RtmRes rtc_replace_component_by_name (in string name1, in string name2)
 Replace two child components.

RTCBaseList rtc_components ()
 Get child components list.

RTCBase rtc_get_component (in string name)
 Get child components list.

RtmRes rtc_attach_inport (in InPort in_port)
 Get child components list.

RtmRes rtc_attach_inport_by_name (in RTCBase comp, in string name)
 Get child components list.

RtmRes rtc_detatch_inport (in InPort in_port)
 Get child components list.

RtmRes rtc_detatch_inport_by_name (in string name)
 Get child components list.

RtmRes rtc_attach_outport (in OutPort out_port)
 Get child components list.

RtmRes rtc_attach_outport_by_name (in RTCBase comp, in string name)
 Get child components list.

RtmRes rtc_detatch_outport (in OutPort out_port)
 Get child components list.

RtmRes rtc_detatch_outport_by_name (in string name)
 Get child components list.

RtmRes rtc_start () raises (IllegalTransition)
 Activate this components' activity.

RtmRes rtc_stop () raises (IllegalTransition)
 Stop this component's activity.

RtmRes rtc_reset () raises (IllegalTransition)
 Go to init() state from error() state.

RtmRes rtc_exit () raises (IllegalTransition)
 Go to term() state from anywhere.

RtmRes rtc_kill ()
 Go to exiting() state from active() state.

RtmRes rtc_worker ()
 Main activity function.

InPort get_inport (in string name) raises (NoSuchName)
 Return input port object reference.

OutPort get_outport (in string name) raises (NoSuchName)
 Return output port object reference.


Public Attributes

readonly attribute RTCProfile profile
 RTComponent's profile.

readonly attribute string instance_id
 Instance ID.

readonly attribute string implementation_id
 Implementation ID.

readonly attribute string description
 Description of a component.

readonly attribute string version
 Version of a component.

readonly attribute string maker
 Component maker.

readonly attribute string category
 Component category.

const ComponentState RTC_UNKNOWN = 0
 UNKNOWN state.

const ComponentState RTC_BORN = 1
 BORN state.

const ComponentState RTC_INITIALIZING = 2
 INITIALIZING state.

const ComponentState RTC_READY = 3
 READY state.

const ComponentState RTC_STARTING = 4
 STARTING state.

const ComponentState RTC_ACTIVE = 5
 ACTIVE state.

const ComponentState RTC_STOPPING = 6
 STOPPING state.

const ComponentState RTC_ABORTING = 7
 ABORTING state.

const ComponentState RTC_ERROR = 8
 ERROR state.

const ComponentState RTC_FATAL_ERROR = 9
 FATAL_ERROR state.

const ComponentState RTC_EXITING = 10
 EXITING state.

readonly attribute OutPort rtc_state
 Get activity status OutPort.

readonly attribute InPortList inports
 Return input port object reference list.

readonly attribute OutPortList outports
 Return output port object reference list.


Detailed Description

RTCBase interface.


Member Typedef Documentation

typedef short RTM::RTComponent::ComponentState [inherited]
 

Component activity state.


Member Function Documentation

InPort RTM::RTComponent::get_inport in string  name  )  raises (NoSuchName) [inherited]
 

Return input port object reference.

Parameters:
name InPort name

OutPort RTM::RTComponent::get_outport in string  name  )  raises (NoSuchName) [inherited]
 

Return output port object reference.

Parameters:
name OutPort name

RtmRes RTM::RTCBase::rtc_aborting_entry  ) 
 

entry: aborting() method.

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

RtmRes RTM::RTCBase::rtc_active_do  ) 
 

do: active() method.

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

RtmRes RTM::RTCBase::rtc_active_entry  ) 
 

entry: active() method.

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

RtmRes RTM::RTCBase::rtc_active_exit  ) 
 

exit: active() method.

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

RtmRes RTM::RTCBase::rtc_add_component in RTCBase  comp  ) 
 

Set child component.

RtmRes RTM::RTCBase::rtc_attach_inport in InPort  in_port  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_attach_inport_by_name in RTCBase  comp,
in string  name
 

Get child components list.

RtmRes RTM::RTCBase::rtc_attach_outport in OutPort  out_port  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_attach_outport_by_name in RTCBase  comp,
in string  name
 

Get child components list.

RTCBaseList RTM::RTCBase::rtc_components  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_delete_component in RTCBase  comp  ) 
 

Delete child component.

RtmRes RTM::RTCBase::rtc_detatch_inport in InPort  in_port  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_detatch_inport_by_name in string  name  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_detatch_outport in OutPort  out_port  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_detatch_outport_by_name in string  name  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_error_do  ) 
 

do: ready() method.

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

RtmRes RTM::RTCBase::rtc_error_entry  ) 
 

entry: error() method.

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

RtmRes RTM::RTCBase::rtc_error_exit  ) 
 

exit: error() method.

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

RtmRes RTM::RTComponent::rtc_exit  )  raises (IllegalTransition) [inherited]
 

Go to term() state from anywhere.

RtmRes RTM::RTCBase::rtc_exiting_entry  ) 
 

entry: exiting() method.

This method will be called and terminate component.

RtmRes RTM::RTCBase::rtc_fatal_do  ) 
 

do: fatal() method.

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

RtmRes RTM::RTCBase::rtc_fatal_entry  ) 
 

entry: fatal() method.

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

RtmRes RTM::RTCBase::rtc_fatal_exit  ) 
 

exit: fatal() method.

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

RTCBase RTM::RTCBase::rtc_get_component in string  name  ) 
 

Get child components list.

RtmRes RTM::RTCBase::rtc_init_entry  ) 
 

entry: ready() method.

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

RtmRes RTM::RTComponent::rtc_kill  )  [inherited]
 

Go to exiting() state from active() state.

RtmRes RTM::RTCBase::rtc_ready_do  ) 
 

do: ready() method.

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

RtmRes RTM::RTCBase::rtc_ready_entry  ) 
 

entry: ready() method.

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

RtmRes RTM::RTCBase::rtc_ready_exit  ) 
 

exit: ready() method.

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

RtmRes RTM::RTCBase::rtc_replace_component in RTCBase  comp1,
in RTCBase  comp2
 

Replace two child components.

RtmRes RTM::RTCBase::rtc_replace_component_by_name in string  name1,
in string  name2
 

Replace two child components.

RtmRes RTM::RTComponent::rtc_reset  )  raises (IllegalTransition) [inherited]
 

Go to init() state from error() state.

RtmRes RTM::RTCBase::rtc_set_parent in RTCBase  comp  ) 
 

Set parent component.

RtmRes RTM::RTComponent::rtc_start  )  raises (IllegalTransition) [inherited]
 

Activate this components' activity.

RtmRes RTM::RTCBase::rtc_start_thread  ) 
 

Stop activity internal thread.

RtmRes RTM::RTCBase::rtc_starting_entry  ) 
 

entry: starting() method.

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

RtmRes RTM::RTComponent::rtc_stop  )  raises (IllegalTransition) [inherited]
 

Stop this component's activity.

RtmRes RTM::RTCBase::rtc_stop_thread  ) 
 

Start activity internal thread.

RtmRes RTM::RTCBase::rtc_stopping_entry  ) 
 

entry: stopping() method.

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

RtmRes RTM::RTComponent::rtc_worker  )  [inherited]
 

Main activity function.

Called from activity thread periodically.


Member Data Documentation

readonly attribute string RTM::RTComponent::category [inherited]
 

Component category.

readonly attribute string RTM::RTComponent::description [inherited]
 

Description of a component.

readonly attribute string RTM::RTComponent::implementation_id [inherited]
 

Implementation ID.

readonly attribute InPortList RTM::RTComponent::inports [inherited]
 

Return input port object reference list.

readonly attribute string RTM::RTComponent::instance_id [inherited]
 

Instance ID.

readonly attribute string RTM::RTComponent::maker [inherited]
 

Component maker.

readonly attribute OutPortList RTM::RTComponent::outports [inherited]
 

Return output port object reference list.

readonly attribute RTCProfile RTM::RTCBase::profile
 

RTComponent's profile.

const ComponentState RTM::RTComponent::RTC_ABORTING = 7 [inherited]
 

ABORTING state.

const ComponentState RTM::RTComponent::RTC_ACTIVE = 5 [inherited]
 

ACTIVE state.

const ComponentState RTM::RTComponent::RTC_BORN = 1 [inherited]
 

BORN state.

const ComponentState RTM::RTComponent::RTC_ERROR = 8 [inherited]
 

ERROR state.

const ComponentState RTM::RTComponent::RTC_EXITING = 10 [inherited]
 

EXITING state.

const ComponentState RTM::RTComponent::RTC_FATAL_ERROR = 9 [inherited]
 

FATAL_ERROR state.

const ComponentState RTM::RTComponent::RTC_INITIALIZING = 2 [inherited]
 

INITIALIZING state.

const ComponentState RTM::RTComponent::RTC_READY = 3 [inherited]
 

READY state.

const ComponentState RTM::RTComponent::RTC_STARTING = 4 [inherited]
 

STARTING state.

readonly attribute OutPort RTM::RTComponent::rtc_state [inherited]
 

Get activity status OutPort.

const ComponentState RTM::RTComponent::RTC_STOPPING = 6 [inherited]
 

STOPPING state.

const ComponentState RTM::RTComponent::RTC_UNKNOWN = 0 [inherited]
 

UNKNOWN state.

readonly attribute string RTM::RTComponent::version [inherited]
 

Version of a component.


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