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

RTM::RTComponent Interface Reference

RTComponent interface. More...

import "RTComponent.idl";

Inheritance diagram for RTM::RTComponent:

RTM::RTCBase List of all members.

Public Types

typedef short ComponentState
 Component activity state.


Public Member Functions

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 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

RTComponent interface.


Member Typedef Documentation

typedef short RTM::RTComponent::ComponentState
 

Component activity state.


Member Function Documentation

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

Return input port object reference.

Parameters:
name InPort name

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

Return output port object reference.

Parameters:
name OutPort name

RtmRes RTM::RTComponent::rtc_exit  )  raises (IllegalTransition)
 

Go to term() state from anywhere.

RtmRes RTM::RTComponent::rtc_kill  ) 
 

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

RtmRes RTM::RTComponent::rtc_reset  )  raises (IllegalTransition)
 

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

RtmRes RTM::RTComponent::rtc_start  )  raises (IllegalTransition)
 

Activate this components' activity.

RtmRes RTM::RTComponent::rtc_stop  )  raises (IllegalTransition)
 

Stop this component's activity.

RtmRes RTM::RTComponent::rtc_worker  ) 
 

Main activity function.

Called from activity thread periodically.


Member Data Documentation

readonly attribute string RTM::RTComponent::category
 

Component category.

readonly attribute string RTM::RTComponent::description
 

Description of a component.

readonly attribute string RTM::RTComponent::implementation_id
 

Implementation ID.

readonly attribute InPortList RTM::RTComponent::inports
 

Return input port object reference list.

readonly attribute string RTM::RTComponent::instance_id
 

Instance ID.

readonly attribute string RTM::RTComponent::maker
 

Component maker.

readonly attribute OutPortList RTM::RTComponent::outports
 

Return output port object reference list.

const ComponentState RTM::RTComponent::RTC_ABORTING = 7
 

ABORTING state.

const ComponentState RTM::RTComponent::RTC_ACTIVE = 5
 

ACTIVE state.

const ComponentState RTM::RTComponent::RTC_BORN = 1
 

BORN state.

const ComponentState RTM::RTComponent::RTC_ERROR = 8
 

ERROR state.

const ComponentState RTM::RTComponent::RTC_EXITING = 10
 

EXITING state.

const ComponentState RTM::RTComponent::RTC_FATAL_ERROR = 9
 

FATAL_ERROR state.

const ComponentState RTM::RTComponent::RTC_INITIALIZING = 2
 

INITIALIZING state.

const ComponentState RTM::RTComponent::RTC_READY = 3
 

READY state.

const ComponentState RTM::RTComponent::RTC_STARTING = 4
 

STARTING state.

readonly attribute OutPort RTM::RTComponent::rtc_state
 

Get activity status OutPort.

const ComponentState RTM::RTComponent::RTC_STOPPING = 6
 

STOPPING state.

const ComponentState RTM::RTComponent::RTC_UNKNOWN = 0
 

UNKNOWN state.

readonly attribute string RTM::RTComponent::version
 

Version of a component.


The documentation for this interface was generated from the following file:
Generated on Thu Dec 16 15:29:34 2004 for OpenRTM by doxygen 1.3.6