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