OpenRTM_aist.PortProfileHelper.PortProfileHelper クラス

[詳解]

クラス
class	conn_id
class	conn_name
class	if_name

公開メンバ関数
def	setPortProfile (self, profile)
def	getPortProfile (self)
def	setName (self, name)
def	getName (self)
def	appendPortInterfaceProfile (self, if_prof)
def	getPortInterfaceProfiles (self)
def	getPortInterfaceProfile (self, instance_name)
def	erasePortInterfaceProfile (self, instance_name)
def	setPortRef (self, port)
def	getPortRef (self)
def	appendConnectorProfile (self, conn_profile)
def	getConnectorProfiles (self)
def	getConnectorProfile (self, name)
def	getConnectorProfileById (self, id)
def	eraseConnectorProfile (self, name)
def	eraseConnectorProfileById (self, id)
def	setOwner (self, owner)
def	getOwner (self)
def	setProperties (self, prop)
def	getProperties (self)

詳解

PortProfile ヘルパークラス

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

メソッド詳解

appendConnectorProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.appendConnectorProfile	(		self,
			conn_profile
	)

ConnectorProfile を追加する

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

引数

conn_profile

ConnectorProfile

void appendConnectorProfile(ConnectorProfile conn_profile);

appendPortInterfaceProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.appendPortInterfaceProfile	(		self,
			if_prof
	)

PortInterfaceProfile を追加する

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

引数

if_profile

PortProfile に追加する PortInterfaceProfile

void appendPortInterfaceProfile(PortInterfaceProfile if_prof);

eraseConnectorProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.eraseConnectorProfile	(		self,
			name
	)

ConnectorProfile を削除する

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

引数

naem	ConnectorProfile の名前

void eraseConnectorProfile(const char* name);

eraseConnectorProfileById()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.eraseConnectorProfileById	(		self,
			id
	)

ConnectorProfile を削除する

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

引数

id	ConnectorProfile のID

void eraseConnectorProfileById(const char* id);

erasePortInterfaceProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.erasePortInterfaceProfile	(		self,
			instance_name
	)

PortInterfaceProfile を削除する

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

引数

instance_name

削除する PortInterfaceProfile の名前

void erasePortInterfaceProfile(const char* instance_name);

getConnectorProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfile	(		self,
			name
	)

ConnectorProfile を取得する

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

引数

name	ConnectorProfile の名前

戻り値

ConnectorProfile

const ConnectorProfile getConnectorProfile(const char* name) const;

getConnectorProfileById()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfileById	(		self,
			id
	)

ConnectorProfile を取得する

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

引数

id	ConnectorProfile のID

戻り値

ConnectorProfile

const ConnectorProfile getConnectorProfileById(const char* id) const;

getConnectorProfiles()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfiles

(

self

)

ConnectorProfileList を取得する

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

戻り値

関連付けられた ConnectorProfileList

const ConnectorProfileList getConnectorProfiles() const;

getName()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getName

(

self

)

PortProfile.name を取得する

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

戻り値

PortProfile.name へのポインタ

const char* getName() const;

getOwner()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getOwner

(

self

)

PortProfile の owner を取得する

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

戻り値

PortProfile の owner のオブジェクト参照

RTObject_ptr getOwner() const;

getPortInterfaceProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortInterfaceProfile	(		self,
			instance_name
	)

PortInterfaceProfile を取得する

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

引数

instance_name

PortInterfaceProfile の instance_name

戻り値

PortInterfaceProfile

const PortInterfaceProfile getPortInterfaceProfile(const char* instance_name) const;

getPortInterfaceProfiles()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortInterfaceProfiles

(

self

)

PortInterfaceProfileList を取得する

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

戻り値

PortInterfaceProfileList

const PortInterfaceProfileList& getPortInterfaceProfiles() const;

getPortProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortProfile

(

self

)

PortProfile を取得する

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

戻り値

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

PortProfile* getPortProfile();

getPortRef()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortRef

(

self

)

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

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

戻り値

関連付けられた Port のオブジェクト参照

PortService_ptr getPortRef() const;

getProperties()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getProperties

(

self

)

PortProfile の properties を取得する

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

戻り値

PortProfile の properties の NVList

const NVList& getProperties() const;

setName()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setName	(		self,
			name
	)

PortProfile.name を設定する

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

引数

name	PortProfile.name に格納する Port の名前

void setName(const char* name);

setOwner()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setOwner	(		self,
			owner
	)

PortProfile の owner を設定する

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

引数

owner

PortProfile の owner のオブジェクト参照

void setOwner(RTObject_ptr owner);

setPortProfile()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setPortProfile	(		self,
			profile
	)

PortProfile を設定する

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

引数

PortProfile

上書きする PortProfile

void setPortProfile(const PortProfile& profile);

setPortRef()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setPortRef	(		self,
			port
	)

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

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

引数

port	設定する Port のオブジェクトリファレンス

void setPortRef(PortService_ptr port);

setProperties()

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.setProperties	(		self,
			prop
	)

PortProfile の properties を設定する

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

引数

prop	PortProfile の properties の NVList

void setProperties(NVList& prop);

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/PortProfileHelper.py