クラス OpenRTM_aist.PortProfileHelper.PortProfileHelper

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

構成
class	conn_name
class	if_name
	instance_name を持つ PortInterfaceProfile を探す Functor [詳細]
Public メソッド
def	setPortProfile
	PortProfile を設定する.
def	getPortProfile
	PortProfile を取得する.
def	setName
	PortProfile.name を設定する.
def	getName
	PortProfile.name を取得する.
def	appendPortInterfaceProfile
	PortInterfaceProfile を追加する.
def	getPortInterfaceProfiles
	PortInterfaceProfileList を取得する.
def	getPortInterfaceProfile
	PortInterfaceProfile を取得する.
def	erasePortInterfaceProfile
	PortInterfaceProfile を削除する.
def	setPortRef
	Port のオブジェクト参照をセットする.
def	getPortRef
	Port のオブジェクト参照を取得する.
def	appendConnectorProfile
	ConnectorProfile を追加する.
def	getConnectorProfiles
	ConnectorProfileList を取得する.
def	getConnectorProfile
	ConnectorProfile を取得する.
def	getConnectorProfileById
	ConnectorProfile を取得する.
def	eraseConnectorProfile
	ConnectorProfile を削除する.
def	eraseConnectorProfileById
	ConnectorProfile を削除する.
def	setOwner
	PortProfile の owner を設定する.
def	getOwner
	PortProfile の owner を取得する.
def	setProperties
	PortProfile の properties を設定する.
def	getProperties
	PortProfile の properties を取得する.

説明

PortProfile ヘルパークラス.

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

メソッド

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

ConnectorProfile を追加する.

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

引数:

conn_profile

ConnectorProfile

void appendConnectorProfile(ConnectorProfile conn_profile);

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

PortInterfaceProfile を追加する.

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

引数:

if_profile

PortProfile に追加する PortInterfaceProfile

void appendPortInterfaceProfile(PortInterfaceProfile if_prof);

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

ConnectorProfile を削除する.

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

引数:

naem

ConnectorProfile の名前

void eraseConnectorProfile(const char* name);

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

ConnectorProfile を削除する.

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

引数:

id

ConnectorProfile のID

void eraseConnectorProfileById(const char* id);

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);

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

ConnectorProfile を取得する.

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

引数:

name

ConnectorProfile の名前

戻り値:: ConnectorProfile

const ConnectorProfile getConnectorProfile(const char* name) const;

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

ConnectorProfile を取得する.

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

引数:

id

ConnectorProfile のID

戻り値:: ConnectorProfile

const ConnectorProfile getConnectorProfileById(const char* id) const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getConnectorProfiles ( self )

ConnectorProfileList を取得する.

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

戻り値:: 関連付けられた ConnectorProfileList

const ConnectorProfileList getConnectorProfiles() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getName ( self )

PortProfile.name を取得する.

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

戻り値:: PortProfile.name へのポインタ

const char* getName() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getOwner ( self )

PortProfile の owner を取得する.

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

戻り値:: PortProfile の owner のオブジェクト参照

RTObject_ptr getOwner() const;

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;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortInterfaceProfiles ( self )

PortInterfaceProfileList を取得する.

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

戻り値:: PortInterfaceProfileList

const PortInterfaceProfileList& getPortInterfaceProfiles() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortProfile ( self )

PortProfile を取得する.

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

戻り値:: このオブジェクトが保持する PortProfile

PortProfile* getPortProfile();

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getPortRef ( self )

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

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

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

PortService_ptr getPortRef() const;

def OpenRTM_aist.PortProfileHelper.PortProfileHelper.getProperties ( self )

PortProfile の properties を取得する.

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

戻り値:: PortProfile の properties の NVList

const NVList& getProperties() const;

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

PortProfile.name を設定する.

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

引数:

name

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

void setName(const char* name);

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

PortProfile の owner を設定する.

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

引数:

owner

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

void setOwner(RTObject_ptr owner);

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

PortProfile を設定する.

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

引数:

PortProfile

上書きする PortProfile

void setPortProfile(const PortProfile& profile);

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

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

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

引数:

port

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

void setPortRef(PortService_ptr port);

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

PortProfile の properties を設定する.

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

引数:

prop

PortProfile の properties の NVList

void setProperties(NVList& prop);

このクラスの説明は次のファイルから生成されました:

/var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PortProfileHelper.py

クラス OpenRTM_aist.PortProfileHelper.PortProfileHelper

構成

Public メソッド

説明

メソッド