#include <OutPortProvider.h>

RTC::OutPortProvider の継承関係図

[凡例]

RTC::OutPortProvider 連携図

[凡例]

クラス
struct	publishInterfaceFunc
	インターフェースプロファイルを公開するたのファンクタ [詳解]

struct	publishInterfaceProfileFunc
	インターフェースプロファイルを公開するたのファンクタ [詳解]

公開メンバ関数
virtual	~OutPortProvider ()
	デストラクタ

virtual void	init (coil::Properties &prop)
	設定初期化

virtual void	setBuffer (CdrBufferBase *buffer)=0
	バッファをセットする

virtual void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners)=0
	リスナを設定する。

virtual void	setConnector (OutPortConnector *connector)=0
	Connectorを設定する。

virtual void	publishInterfaceProfile (SDOPackage::NVList &prop)
	InterfaceProfile情報を公開する

virtual bool	publishInterface (SDOPackage::NVList &prop)
	Interface情報を公開する

限定公開メンバ関数
void	setPortType (const char *port_type)
	ポートタイプを設定する

void	setDataType (const char *data_type)
	データタイプを設定する

void	setInterfaceType (const char *interface_type)
	インターフェースタイプを設定する

void	setDataFlowType (const char *dataflow_type)
	データフロータイプを設定する

void	setSubscriptionType (const char *subs_type)
	サブスクリプションタイプを設定する

限定公開変数類
SDOPackage::NVList	m_properties
	ポートプロファイルを保持するプロパティ

Logger	rtclog
	ロガーストリーム

詳解

OutPortProvider

InPort の PROVIDED インターフェースを実装するための抽象基底クラス。 InPort に対して新しいインターフェースを実装する場合には、このクラスを継承し、以下の関数を実装する必要がある。

さらに、コンストラクタ内で以下の関数を呼び、設定情報を初期化する必要がある。

そのほか、InPortProvider のプロパティとして外部に公開する必要のある値は、protected 変数 (SDOPackage::NVList) m_properties に対してセットすること。セットされた値は、インターフェースのプロファイルとして、また、接続時に他のインターフェースにこのインターフェースに関する情報を与える際に利用される。以下の仮想関数は、ポートのインターフェースプロファイル取得時および接続処理時にポートから呼び出される。予めセットされたこのインターフェースのプロファイル情報はこれらの関数呼び出しによりポートに伝えられる。

InPort は InPortProvider のファクトリ管理クラスに対して利用可能な InPortProvider を問合せ、提供可能なインターフェースタイプを外部に宣言する。従って、InPort　に対して PROVIDED インターフェースを提供する InPortProvider のサブクラスは、InPortProviderFactory にファクトリ関数を登録する必要がある。

RTC::InPortProviderFactory::instance().addFactory() を、

第1引数: プロバイダの名前, "corba_cdr" など
第2引数: ファクトリ関数 coil::Creator<B, T>
第3引数: 削除関数 coil::Destructor<B, T>

を与えて呼び出す必要がある。以下は、ファクトリへの登録と、それを初期化関数とした例である。

extern "C"
{
  void InPortCorbaCdrProviderInit(void)
  {
    RTC::InPortProviderFactory&
                        factory(RTC::InPortProviderFactory::instance());
    factory.addFactory("corba_cdr",
                       ::coil::Creator<RTC::InPortProvider,
                                       RTC::InPortCorbaCdrProvider>,
                       ::coil::Destructor<RTC::InPortProvider,
                                          RTC::InPortCorbaCdrProvider>);
  }
};

この例のように、ファクトリへの登録を初期化関数として、extern "C" によりシンボルを参照可能にしておく。こうすることで、 InPortProvider を共有オブジェクト化 (DLL化) して動的ロード可能にし、プロバイダの型を動的に追加することが可能となる。

から: 0.4.0

OutPort の PROVIDED インターフェースを実装するための抽象基底クラス。 OutPort に対して新しいインターフェースを実装する場合には、このクラスを継承し、以下の関数を実装する必要がある。

さらに、コンストラクタ内で以下の関数を呼び、設定情報を初期化する必要がある。

そのほか、OutPortProvider のプロパティとして外部に公開する必要のある値は、protected 変数 (SDOPackage::NVList) m_properties に対してセットすること。セットされた値は、インターフェースのプロファイルとして、また、接続時に他のインターフェースにこのインターフェースに関する情報を与える際に利用される。以下の仮想関数は、ポートのインターフェースプロファイル取得時および接続処理時にポートから呼び出される。予めセットされたこのインターフェースのプロファイル情報はこれらの関数呼び出しによりポートに伝えられる。

OutPort は OutPortProvider のファクトリ管理クラスに対して利用可能な OutPortProvider を問合せ、提供可能なインターフェースタイプを外部に宣言する。従って、OutPort　に対して PROVIDED インターフェースを提供する OutPortProvider のサブクラスは、OutPortProviderFactory にファクトリ関数を登録する必要がある。

RTC::OutPortProviderFactory::instance().addFactory() を、

第1引数: プロバイダの名前, "corba_cdr" など
第2引数: ファクトリ関数 coil::Creator<B, T>
第3引数: 削除関数 coil::Destructor<B, T>

を与えて呼び出す必要がある。以下は、ファクトリへの登録と、それを初期化関数とした例である。

extern "C"
{
  void OutPortCorbaCdrProviderInit(void)
  {
    RTC::OutPortProviderFactory&
                        factory(RTC::OutPortProviderFactory::instance());
    factory.addFactory("corba_cdr",
                       ::coil::Creator<RTC::OutPortProvider,
                                       RTC::OutPortCorbaCdrProvider>,
                       ::coil::Destructor<RTC::OutPortProvider,
                                          RTC::OutPortCorbaCdrProvider>);
  }
};

この例のように、ファクトリへの登録を初期化関数として、extern "C" によりシンボルを参照可能にしておく。こうすることで、 OutPortProvider を共有オブジェクト化 (DLL化) して動的ロード可能にし、プロバイダの型を動的に追加することが可能となる。

から: 0.4.0

構築子と解体子

◆ ~OutPortProvider()

virtual RTC::OutPortProvider::~OutPortProvider ( )

virtual

デストラクタ

関数詳解

◆ init()

virtual void RTC::OutPortProvider::init ( coil::Properties & prop )

virtual

設定初期化

RTC::OutPortCorbaCdrProvider, RTC::OutPortDirectProvider, RTC::OutPortDSProvider, RTC::OutPortSHMProviderで再実装されています。

◆ publishInterface()

virtual bool RTC::OutPortProvider::publishInterface ( SDOPackage::NVList & prop )

virtual

Interface情報を公開する

参照元 RTC::OutPortProvider::publishInterfaceFunc::operator()().

◆ publishInterfaceProfile()

virtual void RTC::OutPortProvider::publishInterfaceProfile ( SDOPackage::NVList & prop )

virtual

InterfaceProfile情報を公開する

参照元 RTC::OutPortProvider::publishInterfaceProfileFunc::operator()().

◆ setBuffer()

virtual void RTC::OutPortProvider::setBuffer ( CdrBufferBase * buffer )

pure virtual

バッファをセットする

RTC::OutPortCorbaCdrProvider, RTC::OutPortDirectProvider, RTC::OutPortDSProvider, RTC::OutPortSHMProviderで実装されています。

◆ setConnector()

virtual void RTC::OutPortProvider::setConnector ( OutPortConnector * connector )

pure virtual

Connectorを設定する。

RTC::OutPortCorbaCdrProvider, RTC::OutPortDirectProvider, RTC::OutPortDSProvider, RTC::OutPortSHMProviderで実装されています。

◆ setDataFlowType()

void RTC::OutPortProvider::setDataFlowType ( const char * dataflow_type )

protected

データフロータイプを設定する

◆ setDataType()

void RTC::OutPortProvider::setDataType ( const char * data_type )

protected

データタイプを設定する

◆ setInterfaceType()

void RTC::OutPortProvider::setInterfaceType ( const char * interface_type )

protected

インターフェースタイプを設定する

◆ setListener()

virtual void RTC::OutPortProvider::setListener	(	ConnectorInfo &	info,
		ConnectorListenersBase *	listeners
	)

pure virtual

リスナを設定する。

RTC::OutPortCorbaCdrProvider, RTC::OutPortDirectProvider, RTC::OutPortDSProvider, RTC::OutPortSHMProviderで実装されています。

◆ setPortType()

void RTC::OutPortProvider::setPortType ( const char * port_type )

protected

ポートタイプを設定する

◆ setSubscriptionType()

void RTC::OutPortProvider::setSubscriptionType ( const char * subs_type )

protected

サブスクリプションタイプを設定する

メンバ詳解

◆ m_properties

SDOPackage::NVList RTC::OutPortProvider::m_properties

protected

ポートプロファイルを保持するプロパティ

◆ rtclog

Logger RTC::OutPortProvider::rtclog

mutableprotected

ロガーストリーム

このクラス詳解は次のファイルから抽出されました:

OutPortProvider.h

クラス

公開メンバ関数

限定公開メンバ関数

限定公開変数類

詳解

構築子と解体子

◆ ~OutPortProvider()

関数詳解

◆ init()

◆ publishInterface()

◆ publishInterfaceProfile()

◆ setBuffer()

◆ setConnector()

◆ setDataFlowType()

◆ setDataType()

◆ setInterfaceType()

◆ setListener()

◆ setPortType()

◆ setSubscriptionType()

メンバ詳解

◆ m_properties

◆ rtclog