OpenRTM-aist  1.2.1
Classes | Typedefs | Enumerations | Functions
RTC Namespace Reference

RT-Component. More...

Classes

class  BufferBase
 BufferBase abstract class. More...
 
class  BufferStatus
 BufferStatus mixin class. More...
 
class  ComponentActionListeners
 ComponentActionListeners class. More...
 
class  Config
 Config class. More...
 
class  ConfigAdmin
 ConfigAdmin class. More...
 
class  ConfigBase
 ConfigBase abstract class. More...
 
class  ConfigurationListeners
 
class  ConfigurationParamListener
 ConfigurationParamListener class. More...
 
class  ConfigurationParamListenerHolder
 ConfigurationParamListener holder class. More...
 
class  ConfigurationSetListener
 ConfigurationSetListener class. More...
 
class  ConfigurationSetListenerHolder
 ConfigurationSetListener holder class. More...
 
class  ConfigurationSetNameListener
 ConfigurationSetNameListener class. More...
 
class  ConfigurationSetNameListenerHolder
 ConfigurationSetNameListener holder class. More...
 
class  ConnectionCallback
 Callback functor abstract for connect/notify_connect() funcs. More...
 
class  ConnectorBase
 Connector Base class. More...
 
class  ConnectorDataListener
 ConnectorDataListener class. More...
 
class  ConnectorDataListenerHolder
 ConnectorDataListener holder class. More...
 
class  ConnectorDataListenerT
 ConnectorDataListenerT class. More...
 
class  ConnectorInfo
 
class  ConnectorListener
 ConnectorListener class. More...
 
class  ConnectorListenerHolder
 ConnectorListener holder class. More...
 
class  ConnectorListeners
 ConnectorListeners class. More...
 
class  ConnectorListenerStatus
 
class  CorbaConsumer
 
class  CorbaConsumerBase
 
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  DirectInPortBase
 
class  DirectOutPortBase
 
class  DirectPortBase
 
class  DisconnectCallback
 Callback functor abstract for disconnect/notify_disconnect() funcs. More...
 
class  ECFactoryBase
 ECFactoryBase abstract class. More...
 
class  ECFactoryCXX
 ECFactoryCXX class. More...
 
class  ExecutionContextActionListener
 ExecutionContextActionListener class. More...
 
class  ExecutionContextActionListenerHolder
 ExecutionContextActionListener holder 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  InPortDirectConsumer
 InPortDirectConsumer class. More...
 
class  InPortDirectProvider
 InPortDirectProvider class. More...
 
class  InPortProvider
 InPortProvider. More...
 
class  InPortPullConnector
 InPortPullConnector class. More...
 
class  InPortPushConnector
 InPortPushConnector class. More...
 
class  InPortSHMConsumer
 InPortSHMConsumer class. More...
 
class  InPortSHMProvider
 InPortSHMProvider class. More...
 
class  Logger
 Logger class. More...
 
class  LogstreamBase
 
class  LogstreamFile
 
class  Manager
 Manager class. More...
 
class  ManagerConfig
 Manager configuration class. More...
 
class  ModuleManager
 ModuleManager class. More...
 
class  NamingBase
 NamingService management abstract class. More...
 
class  NamingManager
 NamingServer management class. More...
 
class  NamingOnCorba
 NamingServer management class for CORBA. More...
 
class  NamingOnManager
 
class  NamingService
 Structure for NameServer management. More...
 
class  NullBuffer
 Concrete buffer class for dummy. More...
 
class  OnRead
 Callback abstract class on read() More...
 
class  OnReadConvert
 Data convert callback abstract class on read() More...
 
class  OnWrite
 Callback abstract class on write() More...
 
class  OnWriteConvert
 Data convert callback abstract class on write() 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  OutPortDirectConsumer
 OutPortDirectConsumer class. More...
 
class  OutPortDirectProvider
 OutPortDirectProvider class. More...
 
class  OutPortProvider
 OutPortProvider. More...
 
class  OutPortPullConnector
 OutPortPullConnector class. More...
 
class  OutPortPushConnector
 OutPortPushConnector class. More...
 
class  OutPortSHMConsumer
 OutPortSHMConsumer class. More...
 
class  OutPortSHMProvider
 OutPortSHMProvider class. More...
 
class  PeriodicECSharedComposite
 PeriodicECSharedComposite class. More...
 
class  PortActionListener
 PortActionListener class. More...
 
class  PortActionListenerHolder
 PortActionListener holder class. More...
 
class  PortAdmin
 PortAdmin class. More...
 
class  PortBase
 Port base class. More...
 
class  PortConnectListener
 PortConnectListener class. More...
 
class  PortConnectListenerHolder
 PortConnectListener holder class. More...
 
class  PortConnectListeners
 PortConnectListeners class. More...
 
class  PortConnectRetListener
 PortConnectRetListener class. More...
 
class  PortConnectRetListenerHolder
 PortConnectRetListener holder class. More...
 
class  PostComponentActionListener
 PostComponentActionListener class. More...
 
class  PostComponentActionListenerHolder
 PostComponentActionListener holder class. More...
 
class  PreComponentActionListener
 PreComponentActionListener class. More...
 
class  PreComponentActionListenerHolder
 PreComponentActionListener holder 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  SdoServiceProviderBase
 
class  SharedMemoryPort
 
class  SimulatorExecutionContext
 SimulatorExecutionContext class. More...
 
class  Timestamp
 

Typedefs

typedef BufferBase< cdrMemoryStream > CdrBufferBase
 
typedef ::coil::GlobalFactory< CdrBufferBaseCdrBufferFactory
 
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< ConnectorInfoConnectorInfoList
 
typedef std::vector< ConnectorBase * > ConnectorList
 
typedef std::vector< DataPortStatus::EnumDataPortStatusList
 
typedef coil::PeriodicTask DefaultPeriodicTask
 
typedef ExecutionContextBase *(* ECNewFunc) ()
 
typedef void(* ECDeleteFunc) (ExecutionContextBase *ec)
 
typedef coil::GlobalFactory< ExecutionContextBaseExecutionContextFactory
 
typedef RTObject_impl *(* RtcNewFunc) (Manager *manager)
 
typedef void(* RtcDeleteFunc) (RTObject_impl *rtc)
 
typedef ::coil::GlobalFactory< InPortConsumerInPortConsumerFactory
 
typedef ::coil::GlobalFactory< InPortProviderInPortProviderFactory
 InPortProviderFactory type definition. More...
 
typedef std::basic_streambuf< char > StreambufType
 
typedef coil::GlobalFactory< LogstreamBaseLogstreamFactory
 
typedef RTObject_impl RtcBase
 
typedef void(* ModuleInitProc) (Manager *manager)
 
typedef ::coil::GlobalFactory< OutPortConsumerOutPortConsumerFactory
 OutPortConsumerFactory type definition. More...
 
typedef ::coil::GlobalFactory< OutPortProviderOutPortProviderFactory
 OutPortProviderFactory type definition. More...
 
typedef ::coil::GlobalFactory< coil::PeriodicTaskBasePeriodicTaskFactory
 
typedef coil::GlobalFactory< PublisherBasePublisherFactory
 
typedef coil::Properties Properties
 
typedef ::coil::GlobalFactory< ::RTC::SdoServiceConsumerBaseSdoServiceConsumerFactory
 typedef of sdoServiceConsumerFactory More...
 
typedef ::coil::GlobalFactory< ::RTC::SdoServiceProviderBaseSdoServiceProviderFactory
 typedef of sdoServiceProviderFactory More...
 
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

ConnectorListenerStatus::Enum operator| (ConnectorListenerStatus::Enum L, ConnectorListenerStatus::Enum R)
 
ConnectorListenerStatus::Enum operator& (ConnectorListenerStatus::Enum L, ConnectorListenerStatus::Enum R)
 
template<class _New >
ExecutionContextBaseECCreate ()
 Template function to create ExecutionContext. More...
 
template<class _Delete >
void ECDelete (ExecutionContextBase *ec)
 Template function to destroy ExecutionContext. More...
 
template<class _New >
RTObject_implCreate (Manager *manager)
 Template function to create RT-Components. More...
 
template<class _Delete >
void Delete (RTObject_impl *rtc)
 Template function to destroy RT-Components. More...
 

Detailed Description

RT-Component.

Typedef Documentation

typedef BufferBase<cdrMemoryStream> RTC::CdrBufferBase
typedef RingBuffer<cdrMemoryStream> RTC::CdrRingBuffer
typedef std::vector<ConnectorInfo> RTC::ConnectorInfoList
typedef std::vector<ConnectorBase*> RTC::ConnectorList
typedef void(* RTC::ECDeleteFunc) (ExecutionContextBase *ec)
typedef ExecutionContextBase*(* RTC::ECNewFunc) ()

InPortProviderFactory type definition.

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

OutPortConsumerFactory type definition.

OutPortProviderFactory type definition.

typedef void(* RTC::RtcDeleteFunc) (RTObject_impl *rtc)
typedef RTObject_impl*(* RTC::RtcNewFunc) (Manager *manager)

typedef of sdoServiceConsumerFactory

typedef of sdoServiceProviderFactory

typedef std::basic_streambuf<char> RTC::StreambufType
typedef ExecutionContextHandle_t RTC::UniqueId

Enumeration Type Documentation

The types of ConnectorDataListener.

  • ON_UPDATE_CONFIG_PARAM,
Enumerator
ON_UPDATE_CONFIG_PARAM 
CONFIG_PARAM_LISTENER_NUM 

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 

The types of ConfigurationSetNameListener.

Enumerator
ON_UPDATE_CONFIG_SET 
ON_REMOVE_CONFIG_SET 
ON_ACTIVATE_CONFIG_SET 
CONFIG_SET_NAME_LISTENER_NUM 

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 

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 

The types of ExecutionContextActionListener.

Enumerator
EC_ATTACHED 
EC_DETACHED 
EC_ACTION_LISTENER_NUM 

The types of PortActionListener.

Enumerator
ADD_PORT 
REMOVE_PORT 
PORT_ACTION_LISTENER_NUM 

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 

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 

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 

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)

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
managerManager object
Returns
Created RT-Component's instances
template<class _Delete >
void RTC::Delete ( RTObject_impl rtc)

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
rtcThe target RT-Component's instances for destruction
template<class _New >
ExecutionContextBase* RTC::ECCreate ( )

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)

Template function to destroy ExecutionContext.

Template function to destroy ExecutionContext's instances.

Parameters
ecThe target ExecutionContext's instances for destruction