RT-Component. More...

Classes
class	BufferBase
	BufferBase abstract class. More...

class	ByteData

class	ByteDataStream

class	ByteDataStreamBase

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	ConnectorDataListenerHolderT
	ConnectorListener holder class. More...

class	ConnectorDataListenerT
	ConnectorDataListenerT class. More...

class	ConnectorInfo
	ConnectorInfo class. More...

class	ConnectorListener
	ConnectorListener class. More...

class	ConnectorListenerHolder
	ConnectorListener holder class. More...

class	ConnectorListeners
	ConnectorListeners class. More...

class	ConnectorListenersBase

class	ConnectorListenersT
	ConnectorListenersT class. More...

class	ConnectorListenerStatus

class	CORBA_CdrMemoryStream

class	CORBA_CdrSerializer

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

class	Event1

class	EventBase

class	EventBinder0

class	EventBinder1

class	EventBinderBase0

class	EventBinderBase1

class	EventConnListener

class	EventInPort
	EventInPort template 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	FileStream

class	FileStreamBase

class	FsmActionListeners
	FsmActionListeners class. More...

class	FsmProfileListener
	FsmProfileListener class. More...

class	FsmProfileListenerHolder
	FsmProfileListener holder class. More...

class	FsmStructureListener
	FsmStructureListener class. More...

class	FsmStructureListenerHolder
	FsmStructureListener holder 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	InPortCorbaCdrUDPConsumer
	InPortCorbaCdrUDPConsumer class. More...

class	InPortCorbaCdrUDPProvider
	InPortCorbaCdrUDPProvider class. More...

class	InPortDirectConsumer
	InPortDirectConsumer class. More...

class	InPortDirectProvider
	InPortDirectProvider class. More...

class	InPortDSConsumer
	InPortDSConsumer class. More...

class	InPortDSProvider
	InPortDSProvider 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	Link

class	Logger
	Logger class. More...

class	LogstreamBase

class	LogstreamFile

class	Machine

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	OutPortDSConsumer
	OutPortDSConsumer class. More...

class	OutPortDSProvider
	OutPortDSProvider 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	PortProfileHelper
	PortProfile helper class. More...

class	PostComponentActionListener
	PostComponentActionListener class. More...

class	PostComponentActionListenerHolder
	PostComponentActionListener holder class. More...

class	PostFsmActionListener
	PostFsmActionListener class. More...

class	PostFsmActionListenerHolder
	PostFsmActionListener holder class. More...

class	PreComponentActionListener
	PreComponentActionListener class. More...

class	PreComponentActionListenerHolder
	PreComponentActionListener holder class. More...

class	PreFsmActionListener
	PreFsmActionListener class. More...

class	PreFsmActionListenerHolder
	PreFsmActionListener 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	StderrStream

class	StdoutStream

class	Timestamp

class	VxWorksInterruptExecutionContext

Typedefs
using	SerializerFactory = coil::GlobalFactory<ByteDataStreamBase>

using	CdrBufferBase = BufferBase<ByteData>

using	CdrBufferFactory = ::coil::GlobalFactory<CdrBufferBase>

using	CdrRingBuffer = RingBuffer<ByteData>

using	UniqueId = ExecutionContextHandle_t

using	OnUpdateCallback = ConfigurationSetNameListener

using	OnUpdateParamCallback = ConfigurationParamListener

using	OnSetConfigurationSetCallback = ConfigurationSetListener

using	OnAddConfigurationAddCallback = ConfigurationSetListener

using	OnRemoveConfigurationSetCallback = ConfigurationSetNameListener

using	OnActivateSetCallback = ConfigurationSetNameListener

using	ConnectorInfoList = std::vector<ConnectorInfo>

using	ConnectorList = std::vector<ConnectorBase*>

using	DataPortStatusList = std::vector<DataPortStatus>

using	DefaultPeriodicTask = coil::PeriodicTask

using	ECNewFunc = ExecutionContextBase* (*)()

using	ECDeleteFunc = void ()(ExecutionContextBase)

using	ExecutionContextFactory = coil::GlobalFactory<ExecutionContextBase>

using	RtcNewFunc = RTObject_impl* ()(Manager)

using	RtcDeleteFunc = void ()(RTObject_impl)

using	InPortConsumerFactory = ::coil::GlobalFactory<InPortConsumer>

using	InPortProviderFactory = ::coil::GlobalFactory<InPortProvider>
	InPortProviderFactory type definition .

using	StreambufType = coil::LogStreamBuffer

using	LogstreamFactory = coil::GlobalFactory<LogstreamBase>

using	RtcBase = RTObject_impl

using	ModuleInitProc = void ()(Manager)

using	OutPortConsumerFactory = ::coil::GlobalFactory<OutPortConsumer>
	OutPortConsumerFactory type definition .

using	OutPortProviderFactory = ::coil::GlobalFactory<OutPortProvider>
	OutPortProviderFactory type definition .

using	PeriodicTaskFactory = ::coil::GlobalFactory<coil::PeriodicTaskBase>

using	PublisherFactory = coil::GlobalFactory<PublisherBase>

using	Properties = coil::Properties

using	SdoServiceConsumerFactory = ::coil::GlobalFactory< ::RTC::SdoServiceConsumerBase>
	typedef of sdoServiceConsumerFactory

using	SdoServiceProviderFactory = ::coil::GlobalFactory< ::RTC::SdoServiceProviderBase>
	typedef of sdoServiceProviderFactory

using	LogStreamBuf = ::coil::LogStreamBuffer

using	LogStream = ::coil::LogStream

Enumerations
enum class	BufferStatus : uint8_t { OK = 0 , BUFFER_ERROR , FULL , EMPTY , NOT_SUPPORTED , TIMEOUT , PRECONDITION_NOT_MET }
	DataPortStatus return codes. More...

enum class	PreComponentActionListenerType : uint8_t { 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 class	PostComponentActionListenerType : uint8_t { 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 class	PortActionListenerType : uint8_t { ADD_PORT , REMOVE_PORT , PORT_ACTION_LISTENER_NUM }
	The types of PortActionListener. More...

enum class	ExecutionContextActionListenerType : uint8_t { EC_ATTACHED , EC_DETACHED , EC_ACTION_LISTENER_NUM }
	The types of ExecutionContextActionListener. More...

enum class	ConfigurationParamListenerType : uint8_t { ON_UPDATE_CONFIG_PARAM , CONFIG_PARAM_LISTENER_NUM }
	The types of ConnectorDataListener. More...

enum class	ConfigurationSetListenerType : uint8_t { ON_SET_CONFIG_SET , ON_ADD_CONFIG_SET , CONFIG_SET_LISTENER_NUM }
	The types of ConfigurationSetListener. More...

enum class	ConfigurationSetNameListenerType : uint8_t { ON_UPDATE_CONFIG_SET , ON_REMOVE_CONFIG_SET , ON_ACTIVATE_CONFIG_SET , CONFIG_SET_NAME_LISTENER_NUM }
	The types of ConfigurationSetNameListener. More...

enum class	ConnectorDataListenerType : uint8_t { 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 class	ConnectorListenerType : uint8_t { 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 class	DataPortStatus : uint8_t { PORT_OK = 0 , PORT_ERROR , BUFFER_ERROR , BUFFER_FULL , BUFFER_EMPTY , BUFFER_TIMEOUT , SEND_FULL , SEND_TIMEOUT , RECV_EMPTY , RECV_TIMEOUT , INVALID_ARGS , PRECONDITION_NOT_MET , CONNECTION_LOST , UNKNOWN_ERROR }
	DataPortStatus return codes. More...

enum class	PreFsmActionListenerType : uint8_t { PRE_ON_INIT , PRE_ON_ENTRY , PRE_ON_DO , PRE_ON_EXIT , PRE_ON_STATE_CHANGE , PRE_FSM_ACTION_LISTENER_NUM }
	The types of PreFsmActionListener. More...

enum class	PostFsmActionListenerType : uint8_t { POST_ON_INIT , POST_ON_ENTRY , POST_ON_DO , POST_ON_EXIT , POST_ON_STATE_CHANGE , POST_FSM_ACTION_LISTENER_NUM }
	The types of PostFsmActionListener. More...

enum class	FsmProfileListenerType : uint8_t { SET_FSM_PROFILE , GET_FSM_PROFILE , ADD_FSM_STATE , REMOVE_FSM_STATE , ADD_FSM_TRANSITION , REMOVE_FSM_TRANSITION , BIND_FSM_EVENT , UNBIND_FSM_EVENT , FSM_PROFILE_LISTENER_NUM }
	The types of FsmProfileListener. More...

enum class	FsmStructureListenerType : uint8_t { SET_FSM_STRUCTURE , GET_FSM_STRUCTURE , FSM_STRUCTURE_LISTENER_NUM }
	The types of FsmStructureListener. More...

enum class	PortConnectListenerType : uint8_t { ON_NOTIFY_CONNECT , ON_NOTIFY_DISCONNECT , ON_UNSUBSCRIBE_INTERFACES , PORT_CONNECT_LISTENER_NUM }
	The types of ConnectorDataListener. More...

enum class	PortConnectRetListenerType : uint8_t { 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
char const *	toString (BufferStatus status)
	Convert BufferStatus into the string.

template<class DataType >
std::string	addDataTypeToMarshalingType (const std::string &marshalingtype)

template<class DataType , class SerializerType >
void	addSerializer (const std::string &marshalingtype)

template<class DataType >
void	removeSerializer (const std::string &marshalingtype)

template<class DataType >
::RTC::ByteDataStreamBase *	createSerializer (const std::string &marshalingtype)

template<class DataType >
std::vector< std::string >	getSerializerList ()

ConnectorListenerStatus::Enum	operator\| (ConnectorListenerStatus::Enum L, ConnectorListenerStatus::Enum R)

ConnectorListenerStatus::Enum	operator& (ConnectorListenerStatus::Enum L, ConnectorListenerStatus::Enum R)

const char *	toString (DataPortStatus status)
	Convert DataPortStatus into the string.

template<class T_New >
ExecutionContextBase *	ECCreate ()
	Template function to create ExecutionContext.

template<class T_Delete >
void	ECDelete (ExecutionContextBase *ec)
	Template function to destroy ExecutionContext.

template<class T_New >
RTObject_impl *	Create (Manager *manager)
	Template function to create RT-Components.

void	deleteRTObject (RTObject_impl *rtc)

template<class T_Delete >
void	Delete (RTObject_impl *rtc)
	Template function to destroy RT-Components.

Variables
const char *const	default_config []

Detailed Description

RT-Component.

Default configuration for Manager.

Default configuration for Manager class

Since: 0.4.0

Typedef Documentation

◆ CdrBufferBase

using RTC::CdrBufferBase = BufferBase<ByteData>

◆ CdrBufferFactory

using RTC::CdrBufferFactory = ::coil::GlobalFactory<CdrBufferBase>

◆ CdrRingBuffer

using RTC::CdrRingBuffer = RingBuffer<ByteData>

◆ ConnectorInfoList

using RTC::ConnectorInfoList = std::vector<ConnectorInfo>

◆ ConnectorList

using RTC::ConnectorList = std::vector<ConnectorBase*>

◆ DataPortStatusList

using RTC::DataPortStatusList = std::vector<DataPortStatus>

◆ DefaultPeriodicTask

using RTC::DefaultPeriodicTask = coil::PeriodicTask

◆ ECDeleteFunc

using RTC::ECDeleteFunc = void (*)(ExecutionContextBase*)

◆ ECNewFunc

using RTC::ECNewFunc = ExecutionContextBase* (*)()

◆ ExecutionContextFactory

using RTC::ExecutionContextFactory = coil::GlobalFactory<ExecutionContextBase>

◆ InPortConsumerFactory

using RTC::InPortConsumerFactory = ::coil::GlobalFactory<InPortConsumer>

◆ InPortProviderFactory

using RTC::InPortProviderFactory = ::coil::GlobalFactory<InPortProvider>

InPortProviderFactory type definition .

◆ LogStream

using RTC::LogStream = ::coil::LogStream

◆ LogStreamBuf

using RTC::LogStreamBuf = ::coil::LogStreamBuffer

◆ LogstreamFactory

using RTC::LogstreamFactory = coil::GlobalFactory<LogstreamBase>

◆ ModuleInitProc

using RTC::ModuleInitProc = void (*)(Manager*)

◆ OnActivateSetCallback

using RTC::OnActivateSetCallback = ConfigurationSetNameListener

◆ OnAddConfigurationAddCallback

using RTC::OnAddConfigurationAddCallback = ConfigurationSetListener

◆ OnRemoveConfigurationSetCallback

using RTC::OnRemoveConfigurationSetCallback = ConfigurationSetNameListener

◆ OnSetConfigurationSetCallback

using RTC::OnSetConfigurationSetCallback = ConfigurationSetListener

◆ OnUpdateCallback

using RTC::OnUpdateCallback = ConfigurationSetNameListener

◆ OnUpdateParamCallback

using RTC::OnUpdateParamCallback = ConfigurationParamListener

◆ OutPortConsumerFactory

using RTC::OutPortConsumerFactory = ::coil::GlobalFactory<OutPortConsumer>

OutPortConsumerFactory type definition .

◆ OutPortProviderFactory

using RTC::OutPortProviderFactory = ::coil::GlobalFactory<OutPortProvider>

OutPortProviderFactory type definition .

◆ PeriodicTaskFactory

using RTC::PeriodicTaskFactory = ::coil::GlobalFactory<coil::PeriodicTaskBase>

◆ Properties

using RTC::Properties = coil::Properties

◆ PublisherFactory

using RTC::PublisherFactory = coil::GlobalFactory<PublisherBase>

◆ RtcBase

using RTC::RtcBase = RTObject_impl

◆ RtcDeleteFunc

using RTC::RtcDeleteFunc = void (*)(RTObject_impl*)

◆ RtcNewFunc

using RTC::RtcNewFunc = RTObject_impl* (*)(Manager*)

◆ SdoServiceConsumerFactory

using RTC::SdoServiceConsumerFactory = ::coil::GlobalFactory< ::RTC::SdoServiceConsumerBase>

typedef of sdoServiceConsumerFactory

◆ SdoServiceProviderFactory

using RTC::SdoServiceProviderFactory = ::coil::GlobalFactory< ::RTC::SdoServiceProviderBase>

typedef of sdoServiceProviderFactory

◆ SerializerFactory

using RTC::SerializerFactory = coil::GlobalFactory<ByteDataStreamBase>

◆ StreambufType

using RTC::StreambufType = coil::LogStreamBuffer

◆ UniqueId

typedef ExecutionContextHandle_t RTC::UniqueId = ExecutionContextHandle_t

Enumeration Type Documentation

◆ BufferStatus

enum class RTC::BufferStatus : uint8_t

strong

DataPortStatus return codes.

Common return codes for buffer classes.

OK: Normal return
BUFFER_ERROR: Buffer error
FULL: Buffer full
EMPTY: Buffer empty
NOT_SUPPORTED: Not supported function
TIMEOUT: Timeout
PRECONDITION_NOT_MET: Precodition not met

Enumerator
OK
BUFFER_ERROR
FULL
EMPTY
NOT_SUPPORTED
TIMEOUT
PRECONDITION_NOT_MET

◆ ConfigurationParamListenerType

enum class RTC::ConfigurationParamListenerType : uint8_t

strong

The types of ConnectorDataListener.

ON_UPDATE_CONFIG_PARAM,

Enumerator
ON_UPDATE_CONFIG_PARAM
CONFIG_PARAM_LISTENER_NUM

◆ ConfigurationSetListenerType

enum class RTC::ConfigurationSetListenerType : uint8_t

strong

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

◆ ConfigurationSetNameListenerType

enum class RTC::ConfigurationSetNameListenerType : uint8_t

strong

The types of ConfigurationSetNameListener.

Enumerator
ON_UPDATE_CONFIG_SET
ON_REMOVE_CONFIG_SET
ON_ACTIVATE_CONFIG_SET
CONFIG_SET_NAME_LISTENER_NUM

◆ ConnectorDataListenerType

enum class RTC::ConnectorDataListenerType : uint8_t

strong

The types of ConnectorDataListener.

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

◆ ConnectorListenerType

enum class RTC::ConnectorListenerType : uint8_t

strong

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

◆ DataPortStatus

enum class RTC::DataPortStatus : uint8_t

strong

DataPortStatus return codes.

Common return codes for data ports related classes.

PORT_OK: Normal return
PORT_ERROR: Error return
BUFFER_ERROR: Buffer error
BUFFER_FULL: Buffer full
BUFFER_EMPTY: Buffer empty
BUFFER_TIMEOUT: Buffer timeout
SEND_FULL: Buffer full although OutPort tried to send data
SEND_TIMEOUT: Timeout although OutPort tried to send data
RECV_EMPTY: Buffer empty although InPort tried to receive data
RECV_TIMEOUT: Timeout although InPort tried to receive data
INVALID_ARGS: Invalid arguments
PRECONDITION_NOT_MET: Precondition not met
CONNECTION_LOST: Connection has been lost
UNKNOWN_ERROR: Unknown error

This error codes might be used to propagate error status from the error occurring point to the function caller in the data stream path. It would occur in data-transfer path and data receiver/sender. The errors that occur in the interface of each portion of data port are shown below.

(1) Push Type a) The return codes between InPortConsumer and Publisher/Activity PORT_OK, PORT_ERROR, SEND_FULL, SEND_TIMEOUT, CONNECTION_LOST, UNKNOWN_ERROR b) The return codes between Activity and Buffer/Connector of OutPort PORT_OK, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_TIMEOUT, UNKNOWN_ERROR,

(2) Pull Type a) The return codes between Activity and InPort PORT_OK, PORT_ERROR, RECV_EMPTY, RECV_TIMEOUT, CONNETION_LOST, UNKNOWN_ERROR

See function references for detailed return codes for each function.

Enumerator
PORT_OK
PORT_ERROR
BUFFER_ERROR
BUFFER_FULL
BUFFER_EMPTY
BUFFER_TIMEOUT
SEND_FULL
SEND_TIMEOUT
RECV_EMPTY
RECV_TIMEOUT
INVALID_ARGS
PRECONDITION_NOT_MET
CONNECTION_LOST
UNKNOWN_ERROR

◆ ExecutionContextActionListenerType

enum class RTC::ExecutionContextActionListenerType : uint8_t

strong

The types of ExecutionContextActionListener.

Enumerator
EC_ATTACHED
EC_DETACHED
EC_ACTION_LISTENER_NUM

◆ FsmProfileListenerType

enum class RTC::FsmProfileListenerType : uint8_t

strong

The types of FsmProfileListener.

SET_FSM_PROFILE : Setting FSM Profile
GET_FSM_PROFILE : Getting FSM Profile
ADD_FSM_STATE : A State added to the FSM
REMOVE_FSM_STATE : A State removed from FSM
ADD_FSM_TRANSITION : A transition added to the FSM
REMOVE_FSM_TRANSITION : A transition removed from FSM
BIND_FSM_EVENT : An event bounded to the FSM
UNBIND_FSM_EVENT : An event unbounded to the FSM

Enumerator
SET_FSM_PROFILE
GET_FSM_PROFILE
ADD_FSM_STATE
REMOVE_FSM_STATE
ADD_FSM_TRANSITION
REMOVE_FSM_TRANSITION
BIND_FSM_EVENT
UNBIND_FSM_EVENT
FSM_PROFILE_LISTENER_NUM

◆ FsmStructureListenerType

enum class RTC::FsmStructureListenerType : uint8_t

strong

The types of FsmStructureListener.

SET_FSM_STRUCTURE: Setting FSM structure
GET_FSM_STRUCTURE: Getting FSM structure

Enumerator
SET_FSM_STRUCTURE
GET_FSM_STRUCTURE
FSM_STRUCTURE_LISTENER_NUM

◆ PortActionListenerType

enum class RTC::PortActionListenerType : uint8_t

strong

The types of PortActionListener.

Enumerator
ADD_PORT
REMOVE_PORT
PORT_ACTION_LISTENER_NUM

◆ PortConnectListenerType

enum class RTC::PortConnectListenerType : uint8_t

strong

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

◆ PortConnectRetListenerType

enum class RTC::PortConnectRetListenerType : uint8_t

strong

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

◆ PostComponentActionListenerType

enum class RTC::PostComponentActionListenerType : uint8_t

strong

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

◆ PostFsmActionListenerType

enum class RTC::PostFsmActionListenerType : uint8_t

strong

The types of PostFsmActionListener.

PostFsmActionListener has the following hook points. If these listeners are actually called or not called are depends on FSM implementations.

POST_ON_INIT: just after "init" action
POST_ON_ENTRY: just after "entry" action
POST_ON_DO: just after "do" action
POST_ON_EXIT: just after "exit" action
POST_ON_STATE_CHANGE: just after state transition action

Enumerator
POST_ON_INIT
POST_ON_ENTRY
POST_ON_DO
POST_ON_EXIT
POST_ON_STATE_CHANGE
POST_FSM_ACTION_LISTENER_NUM

◆ PreComponentActionListenerType

enum class RTC::PreComponentActionListenerType : uint8_t

strong

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

◆ PreFsmActionListenerType

enum class RTC::PreFsmActionListenerType : uint8_t

strong

The types of PreFsmActionListener.

PreFsmActionListener has the following hook points. If these listeners are actually called or not called are depends on FSM implementations.

PRE_ON_INIT: just before "init" action
PRE_ON_ENTRY: just before "entry" action
PRE_ON_DO: just before "do" action
PRE_ON_EXIT: just before "exit" action
PRE_ON_STATE_CHANGE: just before state transition action

Enumerator
PRE_ON_INIT
PRE_ON_ENTRY
PRE_ON_DO
PRE_ON_EXIT
PRE_ON_STATE_CHANGE
PRE_FSM_ACTION_LISTENER_NUM

Function Documentation

◆ addDataTypeToMarshalingType()

template<class DataType >

std::string RTC::addDataTypeToMarshalingType ( const std::string & marshalingtype )

Parameters

marshalingtype

Returns

References CORBA_Util::toRepositoryId().

Referenced by addSerializer(), createSerializer(), and removeSerializer().

◆ addSerializer()

template<class DataType , class SerializerType >

void RTC::addSerializer ( const std::string & marshalingtype )

Parameters

marshalingtype

References addDataTypeToMarshalingType().

Referenced by CdrMemoryStreamInit().

◆ Create()

template<class T_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 <T_New>.

Parameters

manager Manager object

Returns: Created RT-Component's instances

◆ createSerializer()

template<class DataType >

::RTC::ByteDataStreamBase * RTC::createSerializer ( const std::string & marshalingtype )

Parameters

marshalingtype

References addDataTypeToMarshalingType().

Referenced by RTC::ConnectorDataListenerHolder::notify(), RTC::ConnectorDataListenerHolderT< DataType >::notify(), RTC::ConnectorDataListenerT< DataType >::operator()(), RTC::InPortConnector::read(), and RTC::OutPortConnector::write().

◆ Delete()

template<class T_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 <T_Delete>.

Parameters

rtc	The target RT-Component's instances for destruction

References deleteRTObject().

◆ deleteRTObject()

void RTC::deleteRTObject ( RTObject_impl * rtc )

Parameters

rtc	The target RT-Component's instances for destruction

Referenced by Delete().

◆ ECCreate()

template<class T_New >

ExecutionContextBase * RTC::ECCreate ( )

Template function to create ExecutionContext.

Template function to create ExecutionContext's instances.

Returns: Created ExecutionContext's instances

◆ ECDelete()

template<class T_Delete >

void RTC::ECDelete ( ExecutionContextBase * ec )

Template function to destroy ExecutionContext.

Template function to destroy ExecutionContext's instances.

Parameters

ec	The target ExecutionContext's instances for destruction

◆ getSerializerList()

template<class DataType >

std::vector< std::string > RTC::getSerializerList ( )

Returns

References CORBA_Util::toRepositoryId().

Referenced by RTC::InPort< DataType >::InPort(), and RTC::OutPort< DataType >::OutPort().

◆ operator&()

ConnectorListenerStatus::Enum RTC::operator&	(	ConnectorListenerStatus::Enum	L,
		ConnectorListenerStatus::Enum	R )

◆ operator|()

ConnectorListenerStatus::Enum RTC::operator\|	(	ConnectorListenerStatus::Enum	L,
		ConnectorListenerStatus::Enum	R )

◆ removeSerializer()

template<class DataType >

void RTC::removeSerializer ( const std::string & marshalingtype )

Parameters

marshalingtype

References addDataTypeToMarshalingType().

◆ toString() [1/2]

char const * RTC::toString ( BufferStatus status )

inline

Convert BufferStatus into the string.

Parameters

status The target BufferStatus for transformation

Returns: Trnasformation result of string representation

◆ toString() [2/2]

const char * RTC::toString ( DataPortStatus status )

inline

Convert DataPortStatus into the string.

Parameters

status The target DataPortStatus for transformation

Returns: Trnasformation result of string representation

Variable Documentation

◆ default_config

const char* const RTC::default_config[]

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CdrBufferBase

◆ CdrBufferFactory

◆ CdrRingBuffer

◆ ConnectorInfoList

◆ ConnectorList

◆ DataPortStatusList

◆ DefaultPeriodicTask

◆ ECDeleteFunc

◆ ECNewFunc

◆ ExecutionContextFactory

◆ InPortConsumerFactory

◆ InPortProviderFactory

◆ LogStream

◆ LogStreamBuf

◆ LogstreamFactory

◆ ModuleInitProc

◆ OnActivateSetCallback

◆ OnAddConfigurationAddCallback

◆ OnRemoveConfigurationSetCallback

◆ OnSetConfigurationSetCallback

◆ OnUpdateCallback

◆ OnUpdateParamCallback

◆ OutPortConsumerFactory

◆ OutPortProviderFactory

◆ PeriodicTaskFactory

◆ Properties

◆ PublisherFactory

◆ RtcBase

◆ RtcDeleteFunc

◆ RtcNewFunc

◆ SdoServiceConsumerFactory

◆ SdoServiceProviderFactory

◆ SerializerFactory

◆ StreambufType

◆ UniqueId

Enumeration Type Documentation

◆ BufferStatus

◆ ConfigurationParamListenerType

◆ ConfigurationSetListenerType

◆ ConfigurationSetNameListenerType

◆ ConnectorDataListenerType

◆ ConnectorListenerType

◆ DataPortStatus

◆ ExecutionContextActionListenerType

◆ FsmProfileListenerType

◆ FsmStructureListenerType

◆ PortActionListenerType

◆ PortConnectListenerType

◆ PortConnectRetListenerType

◆ PostComponentActionListenerType

◆ PostFsmActionListenerType

◆ PreComponentActionListenerType

◆ PreFsmActionListenerType

Function Documentation

◆ addDataTypeToMarshalingType()

◆ addSerializer()

◆ Create()

◆ createSerializer()

◆ Delete()

◆ deleteRTObject()

◆ ECCreate()

◆ ECDelete()

◆ getSerializerList()

◆ operator&()

◆ operator|()

◆ removeSerializer()

◆ toString() [1/2]

◆ toString() [2/2]

Variable Documentation

◆ default_config