OpenRTM
1.0.0
|
#include <InPort.h>
Public メソッド | |
DATAPORTSTATUS_ENUM | InPort (const char *name, DataType &value, int bufsize=64, bool read_block=false, bool write_block=false, int read_timeout=0, int write_timeout=0) |
コンストラクタ [詳細] | |
virtual | ~InPort (void) |
デストラクタ [詳細] | |
virtual const char * | name () |
ポート名称を取得する。 [詳細] | |
virtual bool | isNew () |
最新データが存在するか確認する [詳細] | |
virtual bool | isEmpty () |
バッファが空かどうか確認する [詳細] | |
bool | read () |
DataPort から値を読み出す [詳細] | |
virtual void | update () |
バインドされた T 型の変数に InPort バッファの最新値を読み込む [詳細] | |
void | operator>> (DataType &rhs) |
T 型のデータへ InPort の最新値データを読み込む [詳細] | |
void | setOnRead (OnRead< DataType > *on_read) |
InPort バッファへデータ読み込み時のコールバックの設定 [詳細] | |
void | setOnReadConvert (OnReadConvert< DataType > *on_rconvert) |
InPort バッファへデータ読み出し時のコールバックの設定 [詳細] | |
![]() | |
InPortBase (const char *name, const char *data_type) | |
コンストラクタ [詳細] | |
virtual | ~InPortBase (void) |
void | init (coil::Properties &prop) |
プロパティの初期化 [詳細] | |
coil::Properties & | properties () |
プロパティを取得する [詳細] | |
const std::vector < InPortConnector * > & | connectors () |
Connector を取得 [詳細] | |
ConnectorInfoList | getConnectorProfiles () |
ConnectorProfile を取得 [詳細] | |
coil::vstring | getConnectorIds () |
ConnectorId を取得 [詳細] | |
coil::vstring | getConnectorNames () |
Connectorの名前を取得 [詳細] | |
InPortConnector * | getConnectorById (const char *id) |
ConnectorProfileをIDで取得 [詳細] | |
InPortConnector * | getConnectorByName (const char *name) |
ConnectorProfileを名前で取得 [詳細] | |
bool | getConnectorProfileById (const char *id, ConnectorInfo &prof) |
ConnectorProfileをIDで取得 [詳細] | |
bool | getConnectorProfileByName (const char *name, ConnectorInfo &prof) |
ConnectorProfileを名前で取得 [詳細] | |
virtual void | activateInterfaces () |
InPortを activates する [詳細] | |
virtual void | deactivateInterfaces () |
全ての Port のインターフェースを deactivates する [詳細] | |
void | addConnectorDataListener (ConnectorDataListenerType listener_type, ConnectorDataListener *listener, bool autoclean=true) |
ConnectorDataListener リスナを追加する [詳細] | |
void | removeConnectorDataListener (ConnectorDataListenerType listener_type, ConnectorDataListener *listener) |
ConnectorDataListener リスナを削除する [詳細] | |
void | addConnectorListener (ConnectorListenerType callback_type, ConnectorListener *listener, bool autoclean=true) |
ConnectorListener リスナを追加する [詳細] | |
void | removeConnectorListener (ConnectorListenerType callback_type, ConnectorListener *listener) |
ConnectorDataListener リスナを削除する [詳細] | |
bool | isLittleEndian () |
endian 設定を返す [詳細] | |
virtual ReturnCode_t | connect (ConnectorProfile &connector_profile) throw (CORBA::SystemException) |
[CORBA interface] Port の接続を行う [詳細] | |
![]() | |
PortBase (const char *name="") | |
コンストラクタ [詳細] | |
virtual | ~PortBase (void) |
デストラクタ [詳細] | |
virtual PortProfile * | get_port_profile () throw (CORBA::SystemException) |
[CORBA interface] PortProfileを取得する [詳細] | |
const PortProfile & | getPortProfile () const |
PortProfile を取得する。 [詳細] | |
virtual ConnectorProfileList * | get_connector_profiles () throw (CORBA::SystemException) |
[CORBA interface] ConnectorProfileListを取得する [詳細] | |
virtual ConnectorProfile * | get_connector_profile (const char *connector_id) throw (CORBA::SystemException) |
[CORBA interface] ConnectorProfile を取得する [詳細] | |
virtual ReturnCode_t | notify_connect (ConnectorProfile &connector_profile) throw (CORBA::SystemException) |
[CORBA interface] Port の接続通知を行う [詳細] | |
virtual ReturnCode_t | disconnect (const char *connector_id) throw (CORBA::SystemException) |
[CORBA interface] Port の接続を解除する [詳細] | |
virtual ReturnCode_t | notify_disconnect (const char *connector_id) throw (CORBA::SystemException) |
[CORBA interface] Port の接続解除通知を行う [詳細] | |
virtual ReturnCode_t | disconnect_all () throw (CORBA::SystemException) |
[CORBA interface] Port の全接続を解除する [詳細] | |
void | setName (const char *name) |
Port の名前を設定する [詳細] | |
const char * | getName () const |
Port の名前を取得する [詳細] | |
const PortProfile & | getProfile () const |
PortProfileを取得する [詳細] | |
void | setPortRef (PortService_ptr port_ref) |
Port のオブジェクト参照を設定する [詳細] | |
PortService_ptr | getPortRef () |
Port のオブジェクト参照を取得する [詳細] | |
void | setOwner (RTObject_ptr owner) |
Port の owner の RTObject を指定する [詳細] | |
void | setOnPublishInterfaces (ConnectionCallback *on_publish) |
インターフェースを公開する際に呼ばれるコールバックをセットする [詳細] | |
void | setOnSubscribeInterfaces (ConnectionCallback *on_subscribe) |
インターフェースを取得する際に呼ばれるコールバックをセットする [詳細] | |
void | setOnConnected (ConnectionCallback *on_connected) |
接続完了時に呼ばれるコールバックをセットする [詳細] | |
void | setOnUnsubscribeInterfaces (ConnectionCallback *on_subscribe) |
インターフェースを解放する際に呼ばれるコールバックをセットする [詳細] | |
void | setOnDisconnected (ConnectionCallback *on_disconnected) |
接続解除に呼ばれるコールバックをセットする [詳細] | |
void | setOnConnectionLost (ConnectionCallback *on_connection_lost) |
ポートの接続がロストした場合に呼び出されるコールバックをセットする [詳細] | |
void | setPortConnectListenerHolder (PortConnectListeners *portconnListeners) |
PortConnectListeners のホルダをセットする [詳細] | |
InPort テンプレートクラス
InPort の実装である InPort<T> のテンプレートクラス。 <T> はBasicDataType.idl にて定義されている型で、メンバとして Time 型の tm , および T型の data を持つ構造体でなくてはならない。 InPort は内部にリングバッファを持ち、外部から送信されたデータを順次 このリングバッファに格納する。リングバッファのサイズはデフォルトで64と なっているが、コンストラクタ引数によりサイズを指定することができる。 データはフラグによって未読、既読状態が管理され、isNew(), write(), read(), isFull(), isEmpty() 等のメソッドによりハンドリングすることができる。
OnRead系コールバック (読み出しに起因するイベントによりコールされる)
|
inline |
コンストラクタ
コンストラクタ。 パラメータとして与えられる T 型の変数にバインドされる。
name | InPort 名。InPortBase:name() により参照される。 |
value | この InPort にバインドされる T 型の変数 |
bufsize | InPort 内部のリングバッファのバッファ長(デフォルト値:64) |
read_block | 読込ブロックフラグ。 データ読込時に未読データがない場合、次のデータ受信までブロックする かどうかを設定(デフォルト値:false) |
write_block | 書込ブロックフラグ。 データ書込時にバッファがフルであった場合、バッファに空きができる までブロックするかどうかを設定(デフォルト値:false) |
read_timeout | 読込ブロックを指定していない場合の、データ読取タイム アウト時間(ミリ秒)(デフォルト値:0) |
write_timeout | 書込ブロックを指定していない場合の、データ書込タイム アウト時間(ミリ秒)(デフォルト値:0) |
|
inlinevirtual |
デストラクタ
デストラクタ。
|
inlinevirtual |
バッファが空かどうか確認する
InPortのバッファが空かどうかを bool 値で返す。 空の場合は true, 未読データがある場合は false を返す。
参照先 RTC::InPortBase::m_connectors, RTC::PortBase::m_connectorsMutex, RTC_DEBUG, と RTC_TRACE.
|
inlinevirtual |
最新データが存在するか確認する
InPortに未読の最新データが到着しているかをbool値で返す。 InPortが未接続の場合、および接続コネクタのバッファがEmpty の場合にはfalseを返す。
参照先 RTC::InPortBase::m_connectors, RTC::PortBase::m_connectorsMutex, RTC_DEBUG, と RTC_TRACE.
|
inlinevirtual |
ポート名称を取得する。
ポート名称を取得する。
|
inline |
|
inlinevirtual |
DataPort から値を読み出す
InPortに書き込まれたデータを読みだす。接続数が0、またはバッファに データが書き込まれていない状態で読みだした場合の戻り値は不定である。 バッファが空の状態のとき、 事前に設定されたモード (readback, do_nothing, block) に応じて、 以下のような動作をする。
バッファが空の状態では、InPortにバインドされた変数の値が返される。 したがって、初回読み出し時には不定値を返す可能性がある。 この関数を利用する際には、
ことが望ましい。
各コールバック関数は以下のように呼び出される。
RTC::InPortBaseを実装しています。
参照先 RTC::DataPortStatus::BUFFER_EMPTY, RTC::DataPortStatus::BUFFER_TIMEOUT, RTC::InPortBase::m_connectors, RTC::PortBase::m_connectorsMutex, RTC::DataPortStatus::PORT_OK, RTC_DEBUG, RTC_ERROR, RTC_TRACE, と RTC_WARN.
参照元 RTC::InPort< DataType >::operator>>(), と RTC::InPort< DataType >::update().
|
inline |
|
inline |
InPort バッファへデータ読み出し時のコールバックの設定
InPort が持つバッファからデータが読み出される際に呼ばれるコールバック オブジェクトを設定する。コールバックオブジェクトの戻り値がread()メソッド の呼出結果となる。
on_rconvert | OnReadConvert<DataType>型のオブジェクト |
|
inlinevirtual |