クラス RTC::PortProfileHelper

PortProfile ヘルパークラス. [詳細]

#include <PortProfileHelper.h>

すべてのメンバ一覧

構成

struct  conn_id
struct  conn_name
struct  if_name

Public メソッド

 PortProfileHelper ()
virtual ~PortProfileHelper (void)
void setPortProfile (const PortProfile &profile)
 PortProfile を設定する.
PortProfile * getPortProfile ()
 PortProfile を取得する.
void setName (const char *name)
 PortProfile.name を設定する.
const char * getName () const
 PortProfile.name を取得する.
void appendPortInterfaceProfile (PortInterfaceProfile if_prof)
 PortInterfaceProfile を追加する.
const PortInterfaceProfileList & getPortInterfaceProfiles () const
 PortInterfaceProfileList を取得する.
const PortInterfaceProfile getPortInterfaceProfile (const char *instance_name) const
 PortInterfaceProfile を取得する.
void erasePortInterfaceProfile (const char *instance_name)
 PortInterfaceProfile を削除する.
void setPortRef (PortService_ptr port)
 Port のオブジェクト参照をセットする.
PortService_ptr getPortRef () const
 Port のオブジェクト参照を取得する.
void appendConnectorProfile (ConnectorProfile conn_profile)
 ConnectorProfile を追加する.
const ConnectorProfileList getConnectorProfiles () const
 ConnectorProfileList を取得する.
const ConnectorProfile getConnectorProfile (const char *name) const
 ConnectorProfile を取得する.
const ConnectorProfile getConnectorProfileById (const char *id) const
 ConnectorProfile を取得する.
void eraseConnectorProfile (const char *name)
 ConnectorProfile を削除する.
void eraseConnectorProfileById (const char *id)
 ConnectorProfile を削除する.
void setOwner (RTObject_ptr owner)
 PortProfile の owner を設定する.
RTObject_ptr getOwner () const
 PortProfile の owner を取得する.
void setProperties (NVList &prop)
 PortProfile の properties を設定する.
const NVList & getProperties () const
 PortProfile の properties を取得する.

説明

PortProfile ヘルパークラス.

RTC::Port の種々のプロファイルを保持する PortProfile を管理するクラス。 主として PortBase の内部で使用される。


コンストラクタとデストラクタ

RTC::PortProfileHelper::PortProfileHelper (  ) 

コンストラクタ

virtual RTC::PortProfileHelper::~PortProfileHelper ( void   )  [virtual]

デストラクタ


関数

void RTC::PortProfileHelper::appendConnectorProfile ( ConnectorProfile  conn_profile  ) 

ConnectorProfile を追加する.

このオペレーションは PortProfile に ConnectorProfile を追加する。

引数:
conn_profile ConnectorProfile
void RTC::PortProfileHelper::appendPortInterfaceProfile ( PortInterfaceProfile  if_prof  ) 

PortInterfaceProfile を追加する.

このオペレーションは PortProfile に PortInterfaceProfile を追加する。

引数:
if_profile PortProfile に追加する PortInterfaceProfile
void RTC::PortProfileHelper::eraseConnectorProfile ( const char *  name  ) 

ConnectorProfile を削除する.

このオペレーションは PortProfile の ConnectorProfile を 名前で指定して削除する。

引数:
naem ConnectorProfile の名前
void RTC::PortProfileHelper::eraseConnectorProfileById ( const char *  id  ) 

ConnectorProfile を削除する.

このオペレーションは PortProfile の ConnectorProfile を ID で指定して削除する。

引数:
id ConnectorProfile のID
void RTC::PortProfileHelper::erasePortInterfaceProfile ( const char *  instance_name  ) 

PortInterfaceProfile を削除する.

このオペレーションは instance_name で指定された PortInterfaceProfile を削除する。指定した名前の PortInterfaceProfile が存在しない場合には、 NotFound exception を返す。

引数:
instance_name 削除する PortInterfaceProfile の名前
const ConnectorProfile RTC::PortProfileHelper::getConnectorProfile ( const char *  name  )  const

ConnectorProfile を取得する.

このオペレーションは引数で指定された名前を持つ ConnectorProfile を返す。

引数:
name ConnectorProfile の名前
戻り値:
ConnectorProfile
const ConnectorProfile RTC::PortProfileHelper::getConnectorProfileById ( const char *  id  )  const

ConnectorProfile を取得する.

このオペレーションは引数で指定されたIDを持つ ConnectorProfile を返す。

引数:
id ConnectorProfile のID
戻り値:
ConnectorProfile
const ConnectorProfileList RTC::PortProfileHelper::getConnectorProfiles (  )  const

ConnectorProfileList を取得する.

このオペレーションは PortProfile に関連付けられた ConnectorProfile の リスト ConnectorProfileList を返す。

戻り値:
関連付けられた ConnectorProfileList
const char* RTC::PortProfileHelper::getName (  )  const

PortProfile.name を取得する.

このオペレーションは PortProfile.name を取得する。

戻り値:
PortProfile.name へのポインタ
RTObject_ptr RTC::PortProfileHelper::getOwner (  )  const

PortProfile の owner を取得する.

このオペレーションは PortProfile の owner のオブジェクト参照を返す。

戻り値:
PortProfile の owner のオブジェクト参照
const PortInterfaceProfile RTC::PortProfileHelper::getPortInterfaceProfile ( const char *  instance_name  )  const

PortInterfaceProfile を取得する.

このオペレーションは instance_name で指定された PortInterfaceProfile を返す。

引数:
instance_name PortInterfaceProfile の instance_name
戻り値:
PortInterfaceProfile
const PortInterfaceProfileList& RTC::PortProfileHelper::getPortInterfaceProfiles (  )  const

PortInterfaceProfileList を取得する.

このオペレーションは PortInterfaceProfileList を返す。

戻り値:
PortInterfaceProfileList
PortProfile* RTC::PortProfileHelper::getPortProfile (  ) 

PortProfile を取得する.

このオブジェクトが保持する PortProfile を返す。

戻り値:
このオブジェクトが保持する PortProfile
PortService_ptr RTC::PortProfileHelper::getPortRef (  )  const

Port のオブジェクト参照を取得する.

このオペレーションは PortProfile に関連付けられた Port の オブジェクト参照を返す。

戻り値:
関連付けられた Port のオブジェクト参照
const NVList& RTC::PortProfileHelper::getProperties (  )  const

PortProfile の properties を取得する.

このオペレーションは PortProfile の propertiesを返す。

戻り値:
PortProfile の properties の NVList
void RTC::PortProfileHelper::setName ( const char *  name  ) 

PortProfile.name を設定する.

このオペレーションは引数で与えられた文字列をコポーし、 PortProfile.name として保持する。

引数:
name PortProfile.name に格納する Port の名前
void RTC::PortProfileHelper::setOwner ( RTObject_ptr  owner  ) 

PortProfile の owner を設定する.

このオペレーションは PortProfile の owner を設定する。

引数:
owner PortProfile の owner のオブジェクト参照
void RTC::PortProfileHelper::setPortProfile ( const PortProfile &  profile  ) 

PortProfile を設定する.

このオブジェクトが保持する PortProfile を引数で与えられた PortProfile をコピーし上書きして保存する。

引数:
PortProfile 上書きする PortProfile
void RTC::PortProfileHelper::setPortRef ( PortService_ptr  port  ) 

Port のオブジェクト参照をセットする.

このオペレーションは PortProfile に、関連する Port のオブジェクト参照 を設定する。

引数:
port 設定する Port のオブジェクトリファレンス
void RTC::PortProfileHelper::setProperties ( NVList &  prop  ) 

PortProfile の properties を設定する.

このオペレーションは PortProfile に properties を設定する。

引数:
prop PortProfile の properties の NVList
OpenRTMに対してFri Mar 11 00:00:51 2011に生成されました。  doxygen 1.6.3