OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile クラス

[詳解]

クラス
class	find_participant

公開メンバ関数
def	__init__ (self, kind=RTC.PERIODIC)
def	exit (self)
def	setObjRef (self, ec_ptr)
def	getObjRef (self)
def	setRate (self, rate)
def	getRate (self)
def	getKindString (self, kind=None)
def	setKind (self, kind)
def	getKind (self)
def	setOwner (self, comp)
def	getOwner (self)
def	addComponent (self, comp)
def	removeComponent (self, comp)
def	getComponentList (self)
def	setProperties (self, props)
def	getProperties (self)
def	getProfile (self)
def	lock (self)
def	unlock (self)

詳解

ExecutionContextProfile クラス

から

1.2.0

構築子と解体子

__init__()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.__init__	(		self,
			kind = RTC.PERIODIC
	)

デフォルトコンストラクタ

デフォルトコンストラクタ プロファイルに以下の項目を設定する。

• kind : PERIODIC
• rate : 0.0

ExecutionContextProfile(RTC::ExecutionKind kind = RTC::PERIODIC);

メソッド詳解

addComponent()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.addComponent	(		self,
			comp
	)

RTコンポーネントを追加する

指定したRTコンポーネントを参加者リストに追加する。追加されたRTコ ンポーネントは attach_context が呼ばれ、Inactive 状態に遷移する。 指定されたRTコンポーネントがnullの場合は、BAD_PARAMETER が返され る。指定されたRTコンポーネントが DataFlowComponent 以外の場合は、 BAD_PARAMETER が返される。

引数

comp	追加対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t addComponent(RTC::LightweightRTObject_ptr comp);

exit()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.exit

(

self

)

ExecitionContextProfile終了処理

getComponentList()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getComponentList

(

self

)

RTコンポーネントの参加者リストを取得する

現在登録されている参加者RTCのリストを取得する。

戻り値

参加者RTCのリスト

const RTC::RTCList& getComponentList() const;

getKind()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getKind

(

self

)

ExecutionKind を取得する

本 ExecutionContext の ExecutionKind を取得する

戻り値

ExecutionKind

RTC::ExecutionKind getKind(void) const;

getKindString()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getKindString	(		self,
			kind = None
	)

ExecutionKind を文字列化する

RTC::ExecutionKind で定義されている PERIODIC, EVENT_DRIVEN, OTHER を文字列化する。

引数

kind	ExecutionKind

戻り値

文字列化されたExecutionKind

const char* getKindString(RTC::ExecutionKind kind) const;

getObjRef()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getObjRef

(

self

)

CORBA オブジェクト参照の取得

本オブジェクトの ExecutioncontextService としての CORBA オブジェ クト参照を取得する。

戻り値

CORBA オブジェクト参照

RTC::ExecutionContextService_ptr getObjRef(void) const;

getOwner()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getOwner

(

self

)

Ownerコンポーネントの参照を取得する

このECのOwnerであるRTCの参照を取得する。

戻り値

OwnerRTコンポーネントの参照 const RTC::RTObject_ptr getOwner() const;

getProfile()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getProfile

(

self

)

Profileを取得する

RTC::ExecutionContextProfile を取得する。取得した ExecutionContextProfile の所有権は呼び出し側にある。取得されたオ ブジェクトが不要になった場合、呼び出し側が開放する責任を負う。

戻り値

RTC::ExecutionContextProfile

RTC::ExecutionContextProfile* getProfile(void);

getProperties()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getProperties

(

self

)

Propertiesを取得する

ExecutionContextProfile::properties を取得する。

戻り値

coil::Propertiesに変換された ExecutionContextProfile::properties

const coil::Properties getProperties() const;

getRate()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getRate

(

self

)

ExecutionContext の実行周期(Hz)を取得する

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得す る。

戻り値

処理周期(単位:Hz)

double getRate(void) const;

lock()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.lock

(

self

)

ExecutionContextProfileをロックする

このオブジェクトが管理する RTC::ExecutionContextProfile をロックする。 ロックが不要になった際にはunlock()でロックを解除しなければならない。

void lock() const;

removeComponent()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.removeComponent	(		self,
			comp
	)

RTコンポーネントを参加者リストから削除する

指定したRTコンポーネントを参加者リストから削除する。削除された RTコンポーネントは detach_context が呼ばれる。指定されたRTコンポー ネントが参加者リストに登録されていない場合は、BAD_PARAMETER が返 される。

引数

comp	削除対象RTコンポーネント

戻り値

ReturnCode_t 型のリターンコード

RTC::ReturnCode_t removeComponent(RTC::LightweightRTObject_ptr comp);

setKind()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setKind	(		self,
			kind
	)

ExecutionKind を設定する

この ExecutionContext の ExecutionKind を設定する

引数

kind	ExecutionKind

RTC::ReturnCode_t setKind(RTC::ExecutionKind kind);

setObjRef()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setObjRef	(		self,
			ec_ptr
	)

CORBA オブジェクト参照をセット

ExecutioncontextService としての CORBA オブジェ クト参照をセットする。

引数

ec_ptr

CORBA オブジェクト参照

void setObjRef(RTC::ExecutionContextService_ptr ec_ptr);

setOwner()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setOwner	(		self,
			comp
	)

Ownerコンポーネントをセットする。

このECのOwnerとなるRTCをセットする。

引数

comp	OwnerとなるRTコンポーネント

戻り値

ReturnCode_t 型のリターンコード RTC::ReturnCode_t setOwner(RTC::LightweightRTObject_ptr comp);

setProperties()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setProperties	(		self,
			props
	)

Propertiesをセットする

ExecutionContextProfile::properties をセットする。

引数

props

ExecutionContextProfile::properties にセットするプ ロパティー

void setProperties(coil::Properties& props);

setRate()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setRate	(		self,
			rate
	)

ExecutionContext の実行周期(Hz)を設定する

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定す る。実行周期の変更は、DataFlowComponentAction の on_rate_changed によって各RTコンポーネントに伝達される。

引数

rate	処理周期(単位:Hz)

戻り値

ReturnCode_t 型のリターンコード RTC_OK: 正常終了 BAD_PARAMETER: 設定値が負の値

RTC::ReturnCode_t setRate(double rate);

unlock()

def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.unlock

(

self

)

ExecutionContextProfileをアンロックする

このオブジェクトが管理する RTC::ExecutionContextProfile をアンロッ クする。

void unlock() const;

---

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

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