OpenRTM-aist-Python 1.1.2
|
ExecutionContextProfile クラス [詳解]
クラス | |
class | find_participant |
公開メンバ関数 | |
def | __init__ (self, kind=RTC.PERIODIC) |
デフォルトコンストラクタ [詳解] | |
def | __del__ (self) |
デストラクタ [詳解] | |
def | setObjRef (self, ec_ptr) |
CORBA オブジェクト参照をセット [詳解] | |
def | getObjRef (self) |
CORBA オブジェクト参照の取得 [詳解] | |
def | setRate (self, rate) |
ExecutionContext の実行周期(Hz)を設定する [詳解] | |
def | getRate (self) |
ExecutionContext の実行周期(Hz)を取得する [詳解] | |
def | getKindString (self, kind=None) |
ExecutionKind を文字列化する [詳解] | |
def | setKind (self, kind) |
ExecutionKind を設定する [詳解] | |
def | getKind (self) |
ExecutionKind を取得する [詳解] | |
def | setOwner (self, comp) |
Ownerコンポーネントをセットする。 [詳解] | |
def | getOwner (self) |
Ownerコンポーネントの参照を取得する [詳解] | |
def | addComponent (self, comp) |
RTコンポーネントを追加する [詳解] | |
def | removeComponent (self, comp) |
RTコンポーネントを参加者リストから削除する [詳解] | |
def | getComponentList (self) |
RTコンポーネントの参加者リストを取得する [詳解] | |
def | setProperties (self, props) |
Propertiesをセットする [詳解] | |
def | getProperties (self) |
Propertiesを取得する [詳解] | |
def | getProfile (self) |
Profileを取得する [詳解] | |
def | lock (self) |
ExecutionContextProfileをロックする [詳解] | |
def | unlock (self) |
ExecutionContextProfileをアンロックする [詳解] | |
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.__init__ | ( | self, | |
kind = RTC.PERIODIC |
|||
) |
デフォルトコンストラクタ
デフォルトコンストラクタ プロファイルに以下の項目を設定する。
ExecutionContextProfile(RTC::ExecutionKind kind = RTC::PERIODIC);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.__del__ | ( | self | ) |
デストラクタ
デストラクタ
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.addComponent | ( | self, | |
comp | |||
) |
RTコンポーネントを追加する
指定したRTコンポーネントを参加者リストに追加する。追加されたRTコ ンポーネントは attach_context が呼ばれ、Inactive 状態に遷移する。 指定されたRTコンポーネントがnullの場合は、BAD_PARAMETER が返され る。指定されたRTコンポーネントが DataFlowComponent 以外の場合は、 BAD_PARAMETER が返される。
comp | 追加対象RTコンポーネント |
RTC::ReturnCode_t addComponent(RTC::LightweightRTObject_ptr comp);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getComponentList | ( | self | ) |
RTコンポーネントの参加者リストを取得する
現在登録されている参加者RTCのリストを取得する。
const RTC::RTCList& getComponentList() const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getKind | ( | self | ) |
ExecutionKind を取得する
本 ExecutionContext の ExecutionKind を取得する
RTC::ExecutionKind getKind(void) const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getKindString | ( | self, | |
kind = None |
|||
) |
ExecutionKind を文字列化する
RTC::ExecutionKind で定義されている PERIODIC, EVENT_DRIVEN, OTHER を文字列化する。
kind | ExecutionKind |
const char* getKindString(RTC::ExecutionKind kind) const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getObjRef | ( | self | ) |
CORBA オブジェクト参照の取得
本オブジェクトの ExecutioncontextService としての CORBA オブジェ クト参照を取得する。
RTC::ExecutionContextService_ptr getObjRef(void) const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getOwner | ( | self | ) |
Ownerコンポーネントの参照を取得する
このECのOwnerであるRTCの参照を取得する。
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getProfile | ( | self | ) |
Profileを取得する
RTC::ExecutionContextProfile を取得する。取得した ExecutionContextProfile の所有権は呼び出し側にある。取得されたオ ブジェクトが不要になった場合、呼び出し側が開放する責任を負う。
RTC::ExecutionContextProfile* getProfile(void);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getProperties | ( | self | ) |
Propertiesを取得する
ExecutionContextProfile::properties を取得する。
const coil::Properties getProperties() const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.getRate | ( | self | ) |
ExecutionContext の実行周期(Hz)を取得する
Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得す る。
double getRate(void) const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.lock | ( | self | ) |
ExecutionContextProfileをロックする
このオブジェクトが管理する RTC::ExecutionContextProfile をロックする。 ロックが不要になった際にはunlock()でロックを解除しなければならない。
void lock() const;
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.removeComponent | ( | self, | |
comp | |||
) |
RTコンポーネントを参加者リストから削除する
指定したRTコンポーネントを参加者リストから削除する。削除された RTコンポーネントは detach_context が呼ばれる。指定されたRTコンポー ネントが参加者リストに登録されていない場合は、BAD_PARAMETER が返 される。
comp | 削除対象RTコンポーネント |
RTC::ReturnCode_t removeComponent(RTC::LightweightRTObject_ptr comp);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setKind | ( | self, | |
kind | |||
) |
ExecutionKind を設定する
この ExecutionContext の ExecutionKind を設定する
kind | ExecutionKind |
RTC::ReturnCode_t setKind(RTC::ExecutionKind kind);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setObjRef | ( | self, | |
ec_ptr | |||
) |
CORBA オブジェクト参照をセット
ExecutioncontextService としての CORBA オブジェ クト参照をセットする。
ec_ptr | CORBA オブジェクト参照 |
void setObjRef(RTC::ExecutionContextService_ptr ec_ptr);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setOwner | ( | self, | |
comp | |||
) |
Ownerコンポーネントをセットする。
このECのOwnerとなるRTCをセットする。
comp | OwnerとなるRTコンポーネント |
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setProperties | ( | self, | |
props | |||
) |
Propertiesをセットする
ExecutionContextProfile::properties をセットする。
props | ExecutionContextProfile::properties にセットするプ ロパティー |
void setProperties(coil::Properties& props);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.setRate | ( | self, | |
rate | |||
) |
ExecutionContext の実行周期(Hz)を設定する
Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定す る。実行周期の変更は、DataFlowComponentAction の on_rate_changed によって各RTコンポーネントに伝達される。
rate | 処理周期(単位:Hz) |
RTC::ReturnCode_t setRate(double rate);
def OpenRTM_aist.ExecutionContextProfile.ExecutionContextProfile.unlock | ( | self | ) |
ExecutionContextProfileをアンロックする
このオブジェクトが管理する RTC::ExecutionContextProfile をアンロッ クする。
void unlock() const;