RTC Namespace Reference

RT-Component. More...

Classes
class	BufferBase
	BufferBase abstract class. More...
class	NullBuffer
	Concrete buffer class for dummy. More...
class	BufferStatus
	BufferStatus mixin class. More...
class	PreComponentActionListener
	PreComponentActionListener class. More...
class	PostComponentActionListener
	PostComponentActionListener class. More...
class	PortActionListener
	PortActionListener class. More...
class	ExecutionContextActionListener
	ExecutionContextActionListener class. More...
class	PreComponentActionListenerHolder
	PreComponentActionListener holder class. More...
class	PostComponentActionListenerHolder
	PostComponentActionListener holder class. More...
class	PortActionListenerHolder
	PortActionListener holder class. More...
class	ExecutionContextActionListenerHolder
	ExecutionContextActionListener holder class. More...
class	ComponentActionListeners
	ComponentActionListeners class. More...
class	ConfigBase
	ConfigBase abstract class. More...
class	Config
	Config class. More...
class	ConfigAdmin
	ConfigAdmin class. More...
class	ConfigurationParamListener
	ConfigurationParamListener class. More...
class	ConfigurationSetListener
	ConfigurationSetListener class. More...
class	ConfigurationSetNameListener
	ConfigurationSetNameListener class. More...
class	ConfigurationParamListenerHolder
	ConfigurationParamListener holder class. More...
class	ConfigurationSetListenerHolder
	ConfigurationSetListener holder class. More...
class	ConfigurationSetNameListenerHolder
	ConfigurationSetNameListener holder class. More...
class	ConfigurationListeners
class	ConnectorInfo
class	ConnectorBase
	Connector Base class. More...
class	ConnectorDataListener
	ConnectorDataListener class. More...
class	ConnectorDataListenerT
	ConnectorDataListenerT class. More...
class	ConnectorListener
	ConnectorListener class. More...
class	ConnectorDataListenerHolder
	ConnectorDataListener holder class. More...
class	ConnectorListenerHolder
	ConnectorListener holder class. More...
class	ConnectorListeners
	ConnectorListeners class. More...
class	CorbaConsumerBase
class	CorbaConsumer
class	CorbaNaming
	CORBA Naming Service helper class. More...
class	CorbaPort
	RT Conponent CORBA service/consumer Port. More...
class	DataFlowComponentBase
	DataFlowComponentBase class. More...
class	DataPortStatus
	DataPortStatus mixin class. More...
class	ECFactoryBase
	ECFactoryBase abstract class. More...
class	ECFactoryCXX
	ECFactoryCXX class. More...
class	ExecutionContextBase
	A base class for ExecutionContext. More...
class	ExtTrigExecutionContext
	ExecutionContext class that enables one step execution. More...
class	FactoryBase
	FactoryBase base class. More...
class	FactoryCXX
	FactoryCXX class. More...
class	InPort
	InPort template class. More...
class	InPortBase
	Port for InPort. More...
class	InPortConnector
	InPortConnector base class. More...
class	InPortConsumer
	InPortConsumer abstract class. More...
class	InPortCorbaCdrConsumer
	InPortCorbaCdrConsumer class. More...
class	InPortCorbaCdrProvider
	InPortCorbaCdrProvider class. More...
class	InPortProvider
	InPortProvider. More...
class	InPortPullConnector
	InPortPullConnector class. More...
class	InPortPushConnector
	InPortPushConnector class. More...
class	Manager
	Manager class. More...
class	ManagerConfig
	Manager configuration class. More...
class	ModuleManager
	ModuleManager class. More...
class	NamingBase
	NamingService management abstract class. More...
class	NamingOnCorba
	NamingServer management class for CORBA. More...
class	NamingManager
	NamingServer management class. More...
class	OpenHRPExecutionContext
	OpenHRPExecutionContext class. More...
class	OutPort
	OutPort template class. More...
class	OutPortBase
	Output base class. More...
class	OutPortConnector
	OutPortConnector base class. More...
class	OutPortConsumer
	OutPortConsumer abstract class. More...
class	OutPortCorbaCdrConsumer
	OutPortCorbaCdrConsumer class. More...
class	OutPortCorbaCdrProvider
	OutPortCorbaCdrProvider class. More...
class	OutPortProvider
	OutPortProvider. More...
class	OutPortPullConnector
	OutPortPullConnector class. More...
class	OutPortPushConnector
	OutPortPushConnector class. More...
class	PeriodicECSharedComposite
	PeriodicECSharedComposite class. More...
class	PeriodicExecutionContext
	PeriodicExecutionContext class. More...
class	PortAdmin
	PortAdmin class. More...
class	PortBase
	Port base class. More...
class	ConnectionCallback
	Callback functor abstract for connect/notify_connect() funcs. More...
class	DisconnectCallback
	Callback functor abstract for disconnect/notify_disconnect() funcs. More...
class	OnWrite
	Callback abstract class on write(). More...
class	OnWriteConvert
	Data convert callback abstract class on write(). More...
class	OnRead
	Callback abstract class on read(). More...
class	OnReadConvert
	Data convert callback abstract class on read(). More...
class	PortConnectListener
	PortConnectListener class. More...
class	PortConnectRetListener
	PortConnectRetListener class. More...
class	PortConnectListenerHolder
	PortConnectListener holder class. More...
class	PortConnectRetListenerHolder
	PortConnectRetListener holder class. More...
class	PortConnectListeners
	PortConnectListeners class. More...
class	PortProfileHelper
	PortProfile helper class. More...
class	PublisherBase
	Base class of Publisher. More...
class	PublisherFlush
	PublisherFlush class. More...
class	PublisherNew
	PublisherNew class. More...
class	PublisherPeriodic
	PublisherPeriodic class. More...
class	RingBuffer
	Ring buffer implementation class. More...
class	RTObject_impl
	RT-Component class. More...
class	SdoServiceAdmin
class	SdoServiceConsumerBase
class	Logger
	Logger class. More...
Typedefs
typedef BufferBase < cdrMemoryStream >	CdrBufferBase
typedef ::coil::GlobalFactory < CdrBufferBase >	CdrBufferFactory
typedef RingBuffer < cdrMemoryStream >	CdrRingBuffer
typedef ExecutionContextHandle_t	UniqueId
typedef ConfigurationSetNameListener	OnUpdateCallback
typedef ConfigurationParamListener	OnUpdateParamCallback
typedef ConfigurationSetListener	OnSetConfigurationSetCallback
typedef ConfigurationSetListener	OnAddConfigurationAddCallback
typedef ConfigurationSetNameListener	OnRemoveConfigurationSetCallback
typedef ConfigurationSetNameListener	OnActivateSetCallback
typedef std::vector < ConnectorInfo >	ConnectorInfoList
typedef std::vector < ConnectorBase * >	ConnectorList
typedef std::vector < DataPortStatus::Enum >	DataPortStatusList
typedef coil::PeriodicTask	DefaultPeriodicTask
typedef ExecutionContextBase (	ECNewFunc )()
typedef void(*	ECDeleteFunc )(ExecutionContextBase *ec)
typedef RTObject_impl (	RtcNewFunc )(Manager *manager)
typedef void(*	RtcDeleteFunc )(RTObject_impl *rtc)
typedef ::coil::GlobalFactory < InPortConsumer >	InPortConsumerFactory
typedef ::coil::GlobalFactory < InPortProvider >	InPortProviderFactory
	InPortProviderFactory type definition.
typedef RTObject_impl	RtcBase
typedef void(*	ModuleInitProc )(Manager *manager)
typedef ::coil::GlobalFactory < OutPortConsumer >	OutPortConsumerFactory
	OutPortConsumerFactory type definition.
typedef ::coil::GlobalFactory < OutPortProvider >	OutPortProviderFactory
	OutPortProviderFactory type definition.
typedef coil::GlobalFactory < coil::PeriodicTaskBase >	PeriodicTaskFactory
typedef coil::GlobalFactory < PublisherBase >	PublisherFactory
typedef coil::Properties	Properties
typedef ::coil::GlobalFactory < ::RTC::SdoServiceConsumerBase >	SdoServiceConsumerFactory
typedef ::coil::LogStreamBuffer	LogStreamBuf
typedef ::coil::LogStream	LogStream
Enumerations
enum	PreComponentActionListenerType { PRE_ON_INITIALIZE, PRE_ON_FINALIZE, PRE_ON_STARTUP, PRE_ON_SHUTDOWN, PRE_ON_ACTIVATED, PRE_ON_DEACTIVATED, PRE_ON_ABORTING, PRE_ON_ERROR, PRE_ON_RESET, PRE_ON_EXECUTE, PRE_ON_STATE_UPDATE, PRE_ON_RATE_CHANGED, PRE_COMPONENT_ACTION_LISTENER_NUM }
	The types of ConnectorDataListener. More...
enum	PostComponentActionListenerType { POST_ON_INITIALIZE, POST_ON_FINALIZE, POST_ON_STARTUP, POST_ON_SHUTDOWN, POST_ON_ACTIVATED, POST_ON_DEACTIVATED, POST_ON_ABORTING, POST_ON_ERROR, POST_ON_RESET, POST_ON_EXECUTE, POST_ON_STATE_UPDATE, POST_ON_RATE_CHANGED, POST_COMPONENT_ACTION_LISTENER_NUM }
	The types of ConnectorDataListener. More...
enum	PortActionListenerType { ADD_PORT, REMOVE_PORT, PORT_ACTION_LISTENER_NUM }
	The types of PortActionListener. More...
enum	ExecutionContextActionListenerType { EC_ATTACHED, EC_DETACHED, EC_ACTION_LISTENER_NUM }
	The types of ExecutionContextActionListener. More...
enum	ConfigurationParamListenerType { ON_UPDATE_CONFIG_PARAM, CONFIG_PARAM_LISTENER_NUM }
	The types of ConnectorDataListener. More...
enum	ConfigurationSetListenerType { ON_SET_CONFIG_SET, ON_ADD_CONFIG_SET, CONFIG_SET_LISTENER_NUM }
	The types of ConfigurationSetListener. More...
enum	ConfigurationSetNameListenerType { ON_UPDATE_CONFIG_SET, ON_REMOVE_CONFIG_SET, ON_ACTIVATE_CONFIG_SET, CONFIG_SET_NAME_LISTENER_NUM }
	The types of ConfigurationSetNameListener. More...
enum	ConnectorDataListenerType { ON_BUFFER_WRITE = 0, ON_BUFFER_FULL, ON_BUFFER_WRITE_TIMEOUT, ON_BUFFER_OVERWRITE, ON_BUFFER_READ, ON_SEND, ON_RECEIVED, ON_RECEIVER_FULL, ON_RECEIVER_TIMEOUT, ON_RECEIVER_ERROR, CONNECTOR_DATA_LISTENER_NUM }
	The types of ConnectorDataListener. More...
enum	ConnectorListenerType { ON_BUFFER_EMPTY = 0, ON_BUFFER_READ_TIMEOUT, ON_SENDER_EMPTY, ON_SENDER_TIMEOUT, ON_SENDER_ERROR, ON_CONNECT, ON_DISCONNECT, CONNECTOR_LISTENER_NUM }
	The types of ConnectorListener. More...
enum	PortConnectListenerType { ON_NOTIFY_CONNECT, ON_NOTIFY_DISCONNECT, ON_UNSUBSCRIBE_INTERFACES, PORT_CONNECT_LISTENER_NUM }
	The types of ConnectorDataListener. More...
enum	PortConnectRetListenerType { ON_PUBLISH_INTERFACES, ON_CONNECT_NEXTPORT, ON_SUBSCRIBE_INTERFACES, ON_CONNECTED, ON_DISCONNECT_NEXT, ON_DISCONNECTED, PORT_CONNECT_RET_LISTENER_NUM }
	The types of PortConnectRetListenerType. More...
Functions
template<class _New >
ExecutionContextBase *	ECCreate ()
	Template function to create ExecutionContext.
template<class _Delete >
void	ECDelete (ExecutionContextBase *ec)
	Template function to destroy ExecutionContext.
template<class _New >
RTObject_impl *	Create (Manager *manager)
	Template function to create RT-Components.
template<class _Delete >
void	Delete (RTObject_impl *rtc)
	Template function to destroy RT-Components.

Detailed Description

RT-Component.

Typedef Documentation

typedef BufferBase<cdrMemoryStream> RTC::CdrBufferBase

typedef ::coil::GlobalFactory<CdrBufferBase> RTC::CdrBufferFactory

typedef RingBuffer<cdrMemoryStream> RTC::CdrRingBuffer

typedef std::vector<ConnectorInfo> RTC::ConnectorInfoList

typedef std::vector<ConnectorBase*> RTC::ConnectorList

typedef std::vector<DataPortStatus::Enum> RTC::DataPortStatusList

typedef coil::PeriodicTask RTC::DefaultPeriodicTask

typedef void(* RTC::ECDeleteFunc)(ExecutionContextBase *ec)

typedef ExecutionContextBase*(* RTC::ECNewFunc)()

typedef ::coil::GlobalFactory<InPortConsumer> RTC::InPortConsumerFactory

typedef ::coil::GlobalFactory<InPortProvider> RTC::InPortProviderFactory

InPortProviderFactory type definition.

typedef ::coil::LogStream RTC::LogStream

typedef ::coil::LogStreamBuffer RTC::LogStreamBuf

typedef void(* RTC::ModuleInitProc)(Manager *manager)

typedef ConfigurationSetNameListener RTC::OnActivateSetCallback

typedef ConfigurationSetListener RTC::OnAddConfigurationAddCallback

typedef ConfigurationSetNameListener RTC::OnRemoveConfigurationSetCallback

typedef ConfigurationSetListener RTC::OnSetConfigurationSetCallback

typedef ConfigurationSetNameListener RTC::OnUpdateCallback

typedef ConfigurationParamListener RTC::OnUpdateParamCallback

typedef ::coil::GlobalFactory<OutPortConsumer> RTC::OutPortConsumerFactory

OutPortConsumerFactory type definition.

typedef ::coil::GlobalFactory<OutPortProvider> RTC::OutPortProviderFactory

OutPortProviderFactory type definition.

typedef coil::GlobalFactory<coil::PeriodicTaskBase> RTC::PeriodicTaskFactory

typedef coil::Properties RTC::Properties

typedef coil::GlobalFactory<PublisherBase> RTC::PublisherFactory

typedef RTObject_impl RTC::RtcBase

typedef void(* RTC::RtcDeleteFunc)(RTObject_impl *rtc)

typedef RTObject_impl*(* RTC::RtcNewFunc)(Manager *manager)

typedef ::coil::GlobalFactory< ::RTC::SdoServiceConsumerBase > RTC::SdoServiceConsumerFactory

typedef ExecutionContextHandle_t RTC::UniqueId

Enumeration Type Documentation

enum RTC::ConfigurationParamListenerType

The types of ConnectorDataListener.

ON_UPDATE_CONFIG_PARAM,

Enumerator:

ON_UPDATE_CONFIG_PARAM
CONFIG_PARAM_LISTENER_NUM

enum RTC::ConfigurationSetListenerType

The types of ConfigurationSetListener.

ON_SET_CONFIG_SET: Value list has been set as a configuration set
ON_ADD_CONFIG_SET: A new configuration set has been added

Enumerator:

ON_SET_CONFIG_SET
ON_ADD_CONFIG_SET
CONFIG_SET_LISTENER_NUM

enum RTC::ConfigurationSetNameListenerType

The types of ConfigurationSetNameListener.

Enumerator:

ON_UPDATE_CONFIG_SET
ON_REMOVE_CONFIG_SET
ON_ACTIVATE_CONFIG_SET
CONFIG_SET_NAME_LISTENER_NUM

enum RTC::ConnectorDataListenerType

The types of ConnectorDataListener.

ON_BUFFER_WRITE: At the time of buffer write
ON_BUFFER_FULL: At the time of buffer full
ON_BUFFER_WRITE_TIMEOUT: At the time of buffer write timeout
ON_BUFFER_OVERWRITE: At the time of buffer overwrite
ON_BUFFER_READ: At the time of buffer read
ON_SEND: At the time of sending to InPort
ON_RECEIVED: At the time of finishing sending to InPort
ON_RECEIVER_FULL: At the time of bufferfull of InPort
ON_RECEIVER_TIMEOUT: At the time of timeout of InPort
ON_RECEIVER_ERROR: At the time of error of InPort

Enumerator:

ON_BUFFER_WRITE
ON_BUFFER_FULL
ON_BUFFER_WRITE_TIMEOUT
ON_BUFFER_OVERWRITE
ON_BUFFER_READ
ON_SEND
ON_RECEIVED
ON_RECEIVER_FULL
ON_RECEIVER_TIMEOUT
ON_RECEIVER_ERROR
CONNECTOR_DATA_LISTENER_NUM

enum RTC::ConnectorListenerType

The types of ConnectorListener.

ON_BUFFER_EMPTY: At the time of buffer empty
ON_BUFFER_READTIMEOUT: At the time of buffer read timeout
ON_BUFFER_EMPTY: At the time of empty of OutPort
ON_SENDER_TIMEOUT: At the time of timeout of OutPort
ON_SENDER_ERROR: At the time of error of OutPort
ON_CONNECT: At the time of connection
ON_DISCONNECT: At the time of disconnection

Enumerator:

ON_BUFFER_EMPTY
ON_BUFFER_READ_TIMEOUT
ON_SENDER_EMPTY
ON_SENDER_TIMEOUT
ON_SENDER_ERROR
ON_CONNECT
ON_DISCONNECT
CONNECTOR_LISTENER_NUM

enum RTC::ExecutionContextActionListenerType

The types of ExecutionContextActionListener.

Enumerator:

EC_ATTACHED
EC_DETACHED
EC_ACTION_LISTENER_NUM

enum RTC::PortActionListenerType

The types of PortActionListener.

Enumerator:

ADD_PORT
REMOVE_PORT
PORT_ACTION_LISTENER_NUM

enum RTC::PortConnectListenerType

The types of ConnectorDataListener.

ON_NOTIFY_CONNECT: right after entering into notify_connect()
ON_NOTIFY_DISCONNECT: right after entering into notify_disconnect()
ON_UNSUBSCRIBE_INTERFACES: unsubscribing IF in notify_disconnect()

Enumerator:

ON_NOTIFY_CONNECT
ON_NOTIFY_DISCONNECT
ON_UNSUBSCRIBE_INTERFACES
PORT_CONNECT_LISTENER_NUM

enum RTC::PortConnectRetListenerType

The types of PortConnectRetListenerType.

ON_CONNECT_NEXTPORT: after cascade-call in notify_connect()
ON_SUBSCRIBE_INTERFACES: after IF subscribing in notify_connect()
ON_CONNECTED: completed nofity_connect() connection process
ON_DISCONNECT_NEXT: after cascade-call in notify_disconnect()
ON_DISCONNECTED: completed notify_disconnect() disconnection

Enumerator:

ON_PUBLISH_INTERFACES
ON_CONNECT_NEXTPORT
ON_SUBSCRIBE_INTERFACES
ON_CONNECTED
ON_DISCONNECT_NEXT
ON_DISCONNECTED
PORT_CONNECT_RET_LISTENER_NUM

enum RTC::PostComponentActionListenerType

The types of ConnectorDataListener.

Enumerator:

POST_ON_INITIALIZE
POST_ON_FINALIZE
POST_ON_STARTUP
POST_ON_SHUTDOWN
POST_ON_ACTIVATED
POST_ON_DEACTIVATED
POST_ON_ABORTING
POST_ON_ERROR
POST_ON_RESET
POST_ON_EXECUTE
POST_ON_STATE_UPDATE
POST_ON_RATE_CHANGED
POST_COMPONENT_ACTION_LISTENER_NUM

enum RTC::PreComponentActionListenerType

The types of ConnectorDataListener.

Enumerator:

PRE_ON_INITIALIZE
PRE_ON_FINALIZE
PRE_ON_STARTUP
PRE_ON_SHUTDOWN
PRE_ON_ACTIVATED
PRE_ON_DEACTIVATED
PRE_ON_ABORTING
PRE_ON_ERROR
PRE_ON_RESET
PRE_ON_EXECUTE
PRE_ON_STATE_UPDATE
PRE_ON_RATE_CHANGED
PRE_COMPONENT_ACTION_LISTENER_NUM

Function Documentation

template<class _New >

RTObject_impl* RTC::Create ( Manager * manager ) [inline]

Template function to create RT-Components.

This is the template function to create RT-Component's instances. This is invoked from RT-Components manager. Actually, each component's constructor is invoked. Specify the type of the target RT-Components for creation by <_New>.

Parameters:

manager

Manager object

Returns:: Created RT-Component's instances

template<class _Delete >

void RTC::Delete ( RTObject_impl * rtc ) [inline]

Template function to destroy RT-Components.

This is the template function to destroy RT-Component's instances. Specify the type of the target RT-Components for destroy by <_Delete>.

Parameters:

rtc

The target RT-Component's instances for destruction

template<class _New >

ExecutionContextBase* RTC::ECCreate ( ) [inline]

Template function to create ExecutionContext.

Template function to create ExecutionContext's instances.

Returns:: Created ExecutionContext's instances

template<class _Delete >

void RTC::ECDelete ( ExecutionContextBase * ec ) [inline]

Template function to destroy ExecutionContext.

Template function to destroy ExecutionContext's instances.

Parameters:

ec

The target ExecutionContext's instances for destruction

RTC Namespace Reference

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation