RTコンポーネント [詳解]

クラス
class	BufferBase
	BufferBase 抽象クラス [詳解]

class	ByteData
	シリアライズ後のバイト列を操作するクラス [詳解]

class	ByteDataStream
	シリアライザのテンプレートクラスシリアライザを実装する場合は必ずこのクラスを継承する必要がある coil::GlobalFactory <RTC::ByteDataStream>にシリアライザを登録すると使用可能使用するデータ型全てに対してファクトリに登録する必要がある [詳解]

class	ByteDataStreamBase
	シリアライザの基底クラス [詳解]

class	ComponentActionListeners
	ComponentActionListeners クラス [詳解]

class	Config
	Config クラス [詳解]

class	ConfigAdmin
	ConfigAdmin クラス [詳解]

class	ConfigBase
	ConfigBase 抽象クラス [詳解]

class	ConfigurationListeners

class	ConfigurationParamListener
	ConfigurationParamListener クラス [詳解]

class	ConfigurationParamListenerHolder
	ConfigurationParamListener ホルダクラス [詳解]

class	ConfigurationSetListener
	ConfigurationSetListener クラス [詳解]

class	ConfigurationSetListenerHolder
	ConfigurationSetListener ホルダクラス [詳解]

class	ConfigurationSetNameListener
	ConfigurationSetNameListener クラス [詳解]

class	ConfigurationSetNameListenerHolder
	ConfigurationSetNameListener ホルダクラス [詳解]

class	ConnectionCallback
	connect/notify_connect() 時のコールバック抽象クラス [詳解]

class	ConnectorBase
	Connector 基底クラス [詳解]

class	ConnectorDataListener
	ConnectorDataListener クラス [詳解]

class	ConnectorDataListenerHolder
	ConnectorDataListener ホルダクラス [詳解]

class	ConnectorDataListenerHolderT
	データ型指定のConnectorListener ホルダクラス [詳解]

class	ConnectorDataListenerT
	ConnectorDataListenerT クラス [詳解]

class	ConnectorInfo
	ConnectorInfo クラス [詳解]

class	ConnectorListener
	ConnectorListener クラス [詳解]

class	ConnectorListenerHolder
	ConnectorListener ホルダクラス [詳解]

class	ConnectorListeners
	ConnectorListeners クラス [詳解]

class	ConnectorListenersBase

class	ConnectorListenersT
	ConnectorListenersT クラス [詳解]

class	ConnectorListenerStatus
	ConnectorListenerStatus mixin クラス [詳解]

class	CORBA_CdrMemoryStream
	CDRシリアライザ CDRマーシャリングに関わる関数を提供 [詳解]

class	CORBA_CdrSerializer
	CORBAのCDRシリアライザの実装 [詳解]

class	CorbaConsumer
	オブジェクトリファレンスを保持するプレースホルダテンプレートクラス [詳解]

class	CorbaConsumerBase
	オブジェクトリファレンスを保持するプレースホルダ基底クラス [詳解]

class	CorbaNaming
	CORBA Naming Service ヘルパークラス [詳解]

class	CorbaPort
	RT コンポーネント CORBA provider/consumer 用 Port [詳解]

class	DataFlowComponentBase
	DataFlowComponentBase クラス [詳解]

class	DirectInPortBase
	direct接続用InPort基底クラス [詳解]

class	DirectOutPortBase
	direct接続用OutPort基底クラス [詳解]

class	DirectPortBase
	direct接続用Port基底クラス [詳解]

class	DisconnectCallback
	disconnect/notify_disconnect() 時のコールバック抽象クラス [詳解]

class	ECFactoryBase
	ECFactoryBase 抽象クラス [詳解]

class	ECFactoryCXX
	ECFactoryCXX クラス [詳解]

class	Event0

class	Event1

class	EventBase

class	EventBinder0

class	EventBinder1

class	EventBinderBase0

class	EventBinderBase1

class	EventConnListener

class	EventInPort
	EventInPort テンプレートクラス [詳解]

class	ExecutionContextActionListener
	ExecutionContextActionListener クラス [詳解]

class	ExecutionContextActionListenerHolder
	ExecutionContextActionListener ホルダクラス [詳解]

class	ExecutionContextBase
	ExecutionContext用基底クラス [詳解]

class	ExtTrigExecutionContext
	ステップ実行が可能な ExecutionContext クラス [詳解]

class	FactoryBase
	FactoryBase 基底クラス [詳解]

class	FactoryCXX
	FactoryCXX クラス [詳解]

class	FileStream
	ファイル出力のストリーミングラッパークラス [詳解]

class	FileStreamBase
	ファイル出力のストリーミングバッファ基底クラス [詳解]

class	FsmActionListeners
	FsmActionListeners クラス [詳解]

class	FsmProfileListener
	FsmProfileListener クラス [詳解]

class	FsmProfileListenerHolder
	FsmProfileListener ホルダクラス [詳解]

class	FsmStructureListener
	FsmStructureListener クラス [詳解]

class	FsmStructureListenerHolder
	FsmStructureListener ホルダクラス [詳解]

class	InPort
	InPort テンプレートクラス [詳解]

class	InPortBase
	InPort 用 Port [詳解]

class	InPortConnector
	InPortConnector 基底クラス [詳解]

class	InPortConsumer
	InPortConsumer 抽象クラス [詳解]

class	InPortCorbaCdrConsumer
	InPortCorbaCdrConsumer クラス [詳解]

class	InPortCorbaCdrProvider
	InPortCorbaCdrProvider クラス [詳解]

class	InPortCorbaCdrUDPConsumer
	InPortCorbaCdrUDPConsumer クラス [詳解]

class	InPortCorbaCdrUDPProvider
	InPortCorbaCdrUDPProvider クラス [詳解]

class	InPortDirectConsumer
	InPortDirectConsumer クラス [詳解]

class	InPortDirectProvider
	InPortDirectProvider クラス [詳解]

class	InPortDSConsumer
	InPortDSConsumer クラス [詳解]

class	InPortDSProvider
	InPortDSProvider クラス [詳解]

class	InPortProvider

class	InPortPullConnector
	InPortPullConnector クラス [詳解]

class	InPortPushConnector
	InPortPushConnector クラス [詳解]

class	InPortSHMConsumer
	InPortSHMConsumer クラス [詳解]

class	InPortSHMProvider
	InPortSHMProvider クラス [詳解]

class	Link

class	Logger
	Logger クラス [詳解]

class	LogstreamBase

class	LogstreamFile

class	Machine

class	Manager
	Manager クラス [詳解]

class	ManagerConfig
	Manager configuration クラス [詳解]

class	ModuleManager
	モジュールマネージャクラス [詳解]

class	NamingBase
	NamingService 管理用抽象クラス [詳解]

class	NamingManager
	NamingServer 管理クラス [詳解]

class	NamingOnCorba
	CORBA 用 NamingServer 管理クラス [詳解]

class	NamingOnManager
	Manager 用 NamingServer 管理クラス [詳解]

class	NamingService
	NameServer 管理用構造体 [詳解]

class	NullBuffer
	ダミーバッファ実装クラス [詳解]

class	OnRead
	read() 時のコールバック抽象クラス [詳解]

class	OnReadConvert
	read() 時のデータ変換コールバック抽象クラス [詳解]

class	OnWrite
	write() 時のコールバック抽象クラス [詳解]

class	OnWriteConvert
	write() 時のデータ変換コールバック抽象クラス [詳解]

class	OpenHRPExecutionContext
	OpenHRPExecutionContext クラス [詳解]

class	OutPort
	OutPort テンプレートクラス [詳解]

class	OutPortBase
	OutPort 基底クラス [詳解]

class	OutPortConnector
	OutPortConnector 基底クラス [詳解]

class	OutPortConsumer
	OutPortConsumer 抽象クラス [詳解]

class	OutPortCorbaCdrConsumer
	OutPortCorbaCdrConsumer クラス [詳解]

class	OutPortCorbaCdrProvider
	OutPortCorbaCdrProvider クラス [詳解]

class	OutPortDirectConsumer
	OutPortDirectConsumer クラス [詳解]

class	OutPortDirectProvider
	OutPortDirectProvider クラス [詳解]

class	OutPortDSConsumer
	OutPortDSConsumer クラス [詳解]

class	OutPortDSProvider
	OutPortDSProvider クラス [詳解]

class	OutPortProvider
	OutPortProvider [詳解]

class	OutPortPullConnector
	OutPortPullConnector クラス [詳解]

class	OutPortPushConnector
	OutPortPushConnector クラス [詳解]

class	OutPortSHMConsumer
	OutPortSHMConsumer クラス [詳解]

class	OutPortSHMProvider
	OutPortSHMProvider クラス [詳解]

class	PeriodicECSharedComposite
	PeriodicECSharedComposite クラス [詳解]

class	PortActionListener
	PortActionListener クラス [詳解]

class	PortActionListenerHolder
	PortActionListener ホルダクラス [詳解]

class	PortAdmin
	PortAdmin クラス [詳解]

class	PortBase
	Port の基底クラス [詳解]

class	PortConnectListener
	PortConnectListener クラス [詳解]

class	PortConnectListenerHolder
	PortConnectListener ホルダクラス [詳解]

class	PortConnectListeners
	PortConnectListeners クラス [詳解]

class	PortConnectRetListener
	PortConnectRetListener クラス [詳解]

class	PortConnectRetListenerHolder
	PortConnectRetListener ホルダクラス [詳解]

class	PortProfileHelper
	PortProfile ヘルパークラス [詳解]

class	PostComponentActionListener
	PostComponentActionListener クラス [詳解]

class	PostComponentActionListenerHolder
	PostComponentActionListener ホルダクラス [詳解]

class	PostFsmActionListener
	PostFsmActionListener クラス [詳解]

class	PostFsmActionListenerHolder
	PostFsmActionListener ホルダクラス [詳解]

class	PreComponentActionListener
	PreComponentActionListener クラス [詳解]

class	PreComponentActionListenerHolder
	PreComponentActionListener ホルダクラス [詳解]

class	PreFsmActionListener
	PreFsmActionListener クラス [詳解]

class	PreFsmActionListenerHolder
	PreFsmActionListener ホルダクラス [詳解]

class	PublisherBase
	Publisher 基底クラス [詳解]

class	PublisherFlush
	PublisherFlush クラス [詳解]

class	PublisherNew
	PublisherNew クラス [詳解]

class	PublisherPeriodic
	PublisherPeriodic クラス [詳解]

class	RingBuffer
	リングバッファ実装クラス [詳解]

class	RTObject_impl
	RTコンポーネントクラス [詳解]

class	SdoServiceAdmin

class	SdoServiceConsumerBase
	SdoServiceConsumer　基底クラス [詳解]

class	SdoServiceProviderBase
	SdoServiceProvider　基底クラス [詳解]

class	SharedMemoryPort
	SharedMemory クラス [詳解]

class	SimulatorExecutionContext
	SimulatorExecutionContext クラス [詳解]

class	StderrStream
	標準エラー出力のストリーミングラッパークラス [詳解]

class	StdoutStream
	標準出力のストリーミングラッパークラス [詳解]

class	Timestamp

class	VxWorksInterruptExecutionContext
	ハードウェア割り込み、ソフトウェア割り込みで実行する ExecutionContext クラス [詳解]

型定義
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型宣言

using	StreambufType = coil::LogStreamBuffer

using	LogstreamFactory = coil::GlobalFactory<LogstreamBase>

using	RtcBase = RTObject_impl

using	ModuleInitProc = void ()(Manager)

using	OutPortConsumerFactory = ::coil::GlobalFactory<OutPortConsumer>
	OutPortConsumerFactory型宣言

using	OutPortProviderFactory = ::coil::GlobalFactory<OutPortProvider>
	OutPortProviderFactory型宣言

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

using	PublisherFactory = coil::GlobalFactory<PublisherBase>

using	Properties = coil::Properties

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

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

using	LogStreamBuf = ::coil::LogStreamBuffer

using	LogStream = ::coil::LogStream

列挙型
enum class	BufferStatus : uint8_t { OK = 0 , BUFFER_ERROR , FULL , EMPTY , NOT_SUPPORTED , TIMEOUT , PRECONDITION_NOT_MET }
	BufferStatus リターンコード [詳解]

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 }
	PreComponentActionListener のタイプ [詳解]

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 }
	PostCompoenntActionListener のタイプ [詳解]

enum class	PortActionListenerType : uint8_t { ADD_PORT , REMOVE_PORT , PORT_ACTION_LISTENER_NUM }
	PortActionListener のタイプ [詳解]

enum class	ExecutionContextActionListenerType : uint8_t { EC_ATTACHED , EC_DETACHED , EC_ACTION_LISTENER_NUM }
	ExecutionContextActionListener のタイプ [詳解]

enum class	ConfigurationParamListenerType : uint8_t { ON_UPDATE_CONFIG_PARAM , CONFIG_PARAM_LISTENER_NUM }
	ConfigurationParamListener のタイプ [詳解]

enum class	ConfigurationSetListenerType : uint8_t { ON_SET_CONFIG_SET , ON_ADD_CONFIG_SET , CONFIG_SET_LISTENER_NUM }
	ConfigurationSetListener のタイプ [詳解]

enum class	ConfigurationSetNameListenerType : uint8_t { ON_UPDATE_CONFIG_SET , ON_REMOVE_CONFIG_SET , ON_ACTIVATE_CONFIG_SET , CONFIG_SET_NAME_LISTENER_NUM }
	ConfigurationSetNameListenerType [詳解]

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 }
	ConnectorDataListener のタイプ [詳解]

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 }
	ConnectorListener のタイプ [詳解]

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 }

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 }
	PreFsmActionListener のタイプ [詳解]

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 }
	PostFsmActionListener のタイプ [詳解]

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 }
	FsmProfileListener のタイプ [詳解]

enum class	FsmStructureListenerType : uint8_t { SET_FSM_STRUCTURE , GET_FSM_STRUCTURE , FSM_STRUCTURE_LISTENER_NUM }
	FsmStructureListener のタイプ [詳解]

enum class	PortConnectListenerType : uint8_t { ON_NOTIFY_CONNECT , ON_NOTIFY_DISCONNECT , ON_UNSUBSCRIBE_INTERFACES , PORT_CONNECT_LISTENER_NUM }
	PortConnectListener のタイプ [詳解]

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 }
	PortConnectRetListenerType のタイプ [詳解]

関数
char const *	toString (BufferStatus status)
	BufferStatus リターンコードを文字列に変換

template<class DataType >
std::string	addDataTypeToMarshalingType (const std::string &marshalingtype)
	シリアライザの名前にデータ型名を追加する例えば、"corba:RTC/TimedShort:RTC/TimedDouble"という名前のシリアライザ、データ型がTimedDouble型の場合以下のようになる。 IDL:RTC/TimedDouble:1.0:corba:RTC/TimedShort:RTC/TimedDouble

template<class DataType , class SerializerType >
void	addSerializer (const std::string &marshalingtype)
	GlobalFactoryにシリアライザを追加する

template<class DataType >
void	removeSerializer (const std::string &marshalingtype)
	GlobalFactoryからシリアライザを削除する

template<class DataType >
::RTC::ByteDataStreamBase *	createSerializer (const std::string &marshalingtype)
	GlobalFactoryからシリアライザを生成する

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)
	DataPortStatus リターンコードを文字列に変換

template<class T_New >
ExecutionContextBase *	ECCreate ()
	ExecutionContext生成用テンプレート関数

template<class T_Delete >
void	ECDelete (ExecutionContextBase *ec)
	ExecutionContext破棄用テンプレート関数

template<class T_New >
RTObject_impl *	Create (Manager *manager)
	RTコンポーネント生成用テンプレート関数

void	deleteRTObject (RTObject_impl *rtc)
	RTコンポーネント破棄用関数

template<class T_Delete >
void	Delete (RTObject_impl *rtc)
	RTコンポーネント破棄用テンプレート関数

変数
const char *const	default_config []

詳解

RTコンポーネント

Manager 用デフォルト・コンフィギュレーション

Managerクラス用デフォルトコンフィギュレーション。

から: 0.4.0

型定義詳解

◆ 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型宣言

◆ 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型宣言

◆ OutPortProviderFactory

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

OutPortProviderFactory型宣言

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

SdoServiceConsumerFactory の typedef

◆ SdoServiceProviderFactory

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

SdoServiceProviderFactory の typedef

◆ SerializerFactory

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

◆ StreambufType

using RTC::StreambufType = coil::LogStreamBuffer

◆ UniqueId

typedef ExecutionContextHandle_t RTC::UniqueId = ExecutionContextHandle_t

列挙型詳解

◆ BufferStatus

enum class RTC::BufferStatus : uint8_t

strong

BufferStatus リターンコード

バッファ関連のクラスで共通のリターンコード

OK: 正常終了
BUFFER_ERROR: バッファエラー
FULL: バッファフル
EMPTY: バッファエンプティ
NOT_SUPPORTED: 未サポート機能
TIMEOUT: タイムアウト
PRECONDITION_NOT_MET: 事前条件を満たしていない

列挙値
OK
BUFFER_ERROR
FULL
EMPTY
NOT_SUPPORTED
TIMEOUT
PRECONDITION_NOT_MET

◆ ConfigurationParamListenerType

enum class RTC::ConfigurationParamListenerType : uint8_t

strong

ConfigurationParamListener のタイプ

ON_UPDATE_CONFIG_PARAM: パラメータが変更された

列挙値
ON_UPDATE_CONFIG_PARAM
CONFIG_PARAM_LISTENER_NUM

◆ ConfigurationSetListenerType

enum class RTC::ConfigurationSetListenerType : uint8_t

strong

ConfigurationSetListener のタイプ

ON_SET_CONFIG_SET: ConfigurationSet 単位で値がセットされた
ON_ADD_CONFIG_SET: ConfigurationSet が追加された

列挙値
ON_SET_CONFIG_SET
ON_ADD_CONFIG_SET
CONFIG_SET_LISTENER_NUM

◆ ConfigurationSetNameListenerType

enum class RTC::ConfigurationSetNameListenerType : uint8_t

strong

ConfigurationSetNameListenerType

列挙値
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

ConnectorDataListener のタイプ

ON_BUFFER_WRITE: バッファ書き込み時
ON_BUFFER_FULL: バッファフル時
ON_BUFFER_WRITE_TIMEOUT: バッファ書き込みタイムアウト時
ON_BUFFER_OVERWRITE: バッファ上書き時
ON_BUFFER_READ: バッファ読み出し時
ON_SEND: InProtへの送信時
ON_RECEIVED: InProtへの送信完了時
ON_RECEIVER_FULL: InProt側バッファフル時
ON_RECEIVER_TIMEOUT: InProt側バッファタイムアウト時
ON_RECEIVER_ERROR: InProt側エラー時

列挙値
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

ConnectorListener のタイプ

ON_BUFFER_EMPTY: バッファが空の場合
ON_BUFFER_READTIMEOUT: バッファが空でタイムアウトした場合
ON_SENDER_EMPTY: OutPort側バッファが空
ON_SENDER_TIMEOUT: OutPort側タイムアウト時
ON_SENDER_ERROR: OutPort側エラー時
ON_CONNECT: 接続確立時
ON_DISCONNECT: 接続切断時

列挙値
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

brief DataPortStatus リターンコード

データポート関連のクラスで共通のリターンコード

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: 不明なエラー

データポートのデータ経路上のエラー発生個所から呼び出し側へエラー情報を伝えるためにこのエラーコードを使用する。主に、伝送路上のエラー、伝送先のエラーなどが考えられるが、各部分の界面で発生するエラーを以下に列挙する。

(1) Push型 a) InPortConsumer と Publisher/Activity 間で発生するリターンコード PORT_OK, PORT_ERROR, SEND_FULL, SEND_TIMEOUT, CONNECTION_LOST, UNKNOWN_ERROR

b) Activity と OutPort の Buffer/Connector 間で発生するリターンコード PORT_OK, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_TIMEOUT, UNKNOWN_ERROR,

(2) Pull型 a) Activity と InPort の間で発生するリターンコード PORT_OK, PORT_ERROR, RECV_EMPTY, RECV_TIMEOUT, CONNETION_LOST, UNKNOWN_ERROR

各関数が返すリターンコードは関数ごとのリファレンスを参照のこと。

列挙値
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

ExecutionContextActionListener のタイプ

ADD_PORT: ExecutionContext 追加時
REMOVE_PORT: ExecutionContext 削除時

列挙値
EC_ATTACHED
EC_DETACHED
EC_ACTION_LISTENER_NUM

◆ FsmProfileListenerType

enum class RTC::FsmProfileListenerType : uint8_t

strong

FsmProfileListener のタイプ

SET_FSM_PROFILE : FSM Profile設定時
GET_FSM_PROFILE : FSM Profile取得時
ADD_FSM_STATE : FSMにStateが追加された
REMOVE_FSM_STATE : FSMからStateが削除された
ADD_FSM_TRANSITION : FSMに遷移が追加された
REMOVE_FSM_TRANSITION : FSMから遷移が削除された
BIND_FSM_EVENT : FSMにイベントがバインドされた
UNBIND_FSM_EVENT : FSMにイベントがアンバインドされた

列挙値
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

FsmStructureListener のタイプ

SET_FSM_STRUCTURE: FSM構造の設定
GET_FSM_STRUCTURE: FSM構造の取得

列挙値
SET_FSM_STRUCTURE
GET_FSM_STRUCTURE
FSM_STRUCTURE_LISTENER_NUM

◆ PortActionListenerType

enum class RTC::PortActionListenerType : uint8_t

strong

PortActionListener のタイプ

ADD_PORT: Port 追加時
REMOVE_PORT: Port 削除時

列挙値
ADD_PORT
REMOVE_PORT
PORT_ACTION_LISTENER_NUM

◆ PortConnectListenerType

enum class RTC::PortConnectListenerType : uint8_t

strong

PortConnectListener のタイプ

ON_NOTIFY_CONNECT: notify_connect() 関数内呼び出し直後
ON_NOTIFY_DISCONNECT: notify_disconnect() 呼び出し直後
ON_UNSUBSCRIBE_INTERFACES: notify_disconnect() 内のIF購読解除時

列挙値
ON_NOTIFY_CONNECT
ON_NOTIFY_DISCONNECT
ON_UNSUBSCRIBE_INTERFACES
PORT_CONNECT_LISTENER_NUM

◆ PortConnectRetListenerType

enum class RTC::PortConnectRetListenerType : uint8_t

strong

PortConnectRetListenerType のタイプ

ON_CONNECT_NEXTPORT: notify_connect() 中のカスケード呼び出し直後
ON_SUBSCRIBE_INTERFACES: notify_connect() 中のインターフェース購読直後
ON_CONNECTED: nofity_connect() 接続処理完了時に呼び出される
ON_DISCONNECT_NEXT: notify_disconnect() 中にカスケード呼び出し直後
ON_DISCONNECTED: notify_disconnect() リターン時

列挙値
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

PostCompoenntActionListener のタイプ

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

PostFsmActionListener のタイプ

PostFsmActionListener には以下のフックポイントが定義されている。これらが呼び出されるかどうかは、FSMの実装に依存する。

POST_ON_INIT: init 直後
POST_ON_ENTRY: entry 直後
POST_ON_DO: do 直後
POST_ON_EXIT: exit 直後
POST_ON_STATE_CHANGE: 状態遷移直後

列挙値
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

PreComponentActionListener のタイプ

PRE_ON_INITIALIZE: onInitialize 直前
PRE_ON_FINALIZE: onFinalize 直前
PRE_ON_STARTUP: onStartup 直前
PRE_ON_SHUTDOWN: onShutdown 直前
PRE_ON_ACTIVATED: onActivated 直前
PRE_ON_DEACTIVATED: onDeactivated 直前
PRE_ON_ABORTING: onAborted 直前
PRE_ON_ERROR: onError 直前
PRE_ON_RESET: onReset 直前
PRE_ON_EXECUTE: onExecute 直前
PRE_ON_STATE_UPDATE: onStateUpdate 直前
PRE_ON_RATE_CHANGED: onRateChanged 直前

列挙値
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

PreFsmActionListener のタイプ

FSMコンポーネントに関する種々の振る舞いをフックするためのリスナ定義。リスナには大きく分けると、

FSMそのものの動作をフックするためのリスナ
FSMに関するメタデータ変更等の動作をフックするためのリスナ

の2種類に分けられる。さらに前者は、FSMの状態遷移等のアクションの前後それぞれをフックするための PreFsmActionListener と PostFsmActionListener の二つがあり、後者は、FSMのProfileの変更をフックする FsmProfileListener と FSMの構造 (Structure) の変更をフックする FsmStructureListener の二つに分けられる。以上、以下のFSMに関する以下の4種類のリスナークラス群が提供されている。

PreFsmActionListener には以下のフックポイントが定義されている。これらが呼び出されるかどうかは、FSMの実装に依存する。

PRE_ON_INIT: init 直前
PRE_ON_ENTRY: entry 直前
PRE_ON_DO: do 直前
PRE_ON_EXIT: exit 直前
PRE_ON_STATE_CHANGE: 状態遷移直前

列挙値
PRE_ON_INIT
PRE_ON_ENTRY
PRE_ON_DO
PRE_ON_EXIT
PRE_ON_STATE_CHANGE
PRE_FSM_ACTION_LISTENER_NUM

関数詳解

◆ addDataTypeToMarshalingType()

template<class DataType >

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

シリアライザの名前にデータ型名を追加する例えば、"corba:RTC/TimedShort:RTC/TimedDouble"という名前のシリアライザ、データ型がTimedDouble型の場合以下のようになる。 IDL:RTC/TimedDouble:1.0:corba:RTC/TimedShort:RTC/TimedDouble

引数

marshalingtype シリアライザの名称

戻り値: 型名追加後のシリアライザ名

参照先 CORBA_Util::toRepositoryId().

参照元 addSerializer(), createSerializer(), removeSerializer().

◆ addSerializer()

template<class DataType , class SerializerType >

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

GlobalFactoryにシリアライザを追加する

引数

marshalingtype シリアライザの名称

参照先 addDataTypeToMarshalingType().

参照元 CdrMemoryStreamInit().

◆ Create()

template<class T_New >

RTObject_impl * RTC::Create ( Manager * manager )

RTコンポーネント生成用テンプレート関数

RTコンポーネントのインスタンスを生成するためのテンプレート関数。 RTコンポーネント管理用マネージャから呼び出される。実際には各コンポーネントのコンストラクタが呼び出される。 <T_New>で生成対象RTコンポーネントの型を指定する。

引数

manager マネージャオブジェクト

戻り値: 生成した RTコンポーネントインスタンス

◆ createSerializer()

template<class DataType >

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

GlobalFactoryからシリアライザを生成する

引数

marshalingtype シリアライザの名称

参照先 addDataTypeToMarshalingType().

参照元 RTC::ConnectorDataListenerHolder::notify(), RTC::ConnectorDataListenerHolderT< DataType >::notify(), RTC::ConnectorDataListenerT< DataType >::operator()(), RTC::InPortConnector::read(), RTC::OutPortConnector::write().

◆ Delete()

template<class T_Delete >

void RTC::Delete ( RTObject_impl * rtc )

RTコンポーネント破棄用テンプレート関数

RTコンポーネントのインスタンスを破棄するためのテンプレート関数。 <T_Delete>にて破棄対象RTコンポーネントの型を指定する。

引数

rtc	破棄対象RTコンポーネントのインスタンス

参照先 deleteRTObject().

◆ deleteRTObject()

void RTC::deleteRTObject ( RTObject_impl * rtc )

RTコンポーネント破棄用関数

引数

rtc	破棄対象RTコンポーネントのインスタンス

参照元 Delete().

◆ ECCreate()

template<class T_New >

ExecutionContextBase * RTC::ECCreate ( )

ExecutionContext生成用テンプレート関数

ExecutionContextのインスタンスを生成するためのテンプレート関数。

戻り値: 生成したExecutionContextインスタンス

◆ ECDelete()

template<class T_Delete >

void RTC::ECDelete ( ExecutionContextBase * ec )

ExecutionContext破棄用テンプレート関数

ExecutionContextのインスタンスを破棄するためのテンプレート関数。

引数

ec	破棄対象ExecutionContextのインスタンス

◆ getSerializerList()

template<class DataType >

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

使用可能なシリアライザの一覧を取得する

戻り値: 使用可能なシリアライザの一覧

参照先 CORBA_Util::toRepositoryId().

参照元 RTC::InPort< DataType >::InPort(), 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 )

GlobalFactoryからシリアライザを削除する

引数

marshalingtype シリアライザの名称

参照先 addDataTypeToMarshalingType().

◆ toString() [1/2]

char const * RTC::toString ( BufferStatus status )

inline

BufferStatus リターンコードを文字列に変換

BufferStatus リターンコードを文字列に変換する

引数

status 変換対象 BufferStatus リターンコード

戻り値: 文字列変換結果

◆ toString() [2/2]

const char * RTC::toString ( DataPortStatus status )

inline

DataPortStatus リターンコードを文字列に変換

DataPortStatus リターンコードを文字列に変換する

引数

status 変換対象 DataPortStatus リターンコード

戻り値: 文字列変換結果

変数詳解

◆ default_config

const char* const RTC::default_config[]