|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjp.go.aist.rtm.RTC.executionContext.ExecutionContextProfile
public class ExecutionContextProfile
ExecutionContextProfile クラス
Periodic Sampled Data Processing(周期実行用)ExecutionContextクラス。
フィールドの概要 | |
---|---|
static double |
DEEFAULT_PERIOD
|
コンストラクタの概要 | |
---|---|
ExecutionContextProfile()
|
|
ExecutionContextProfile(ExecutionKind kind)
デフォルトコンストラクタ {@.ja デフォルトコンストラクタ プロファイルに以下の項目を設定する。 |
メソッドの概要 | |
---|---|
ReturnCode_t |
addComponent(LightweightRTObject comp)
RTコンポーネントを追加する {@.ja 指定したRTコンポーネントを参加者リストに追加する。 |
RTObject[] |
getComponentList()
RTコンポーネントの参加者リストを取得する {@.ja 現在登録されている参加者RTCのリストを取得する。 |
ExecutionKind |
getKind()
ExecutionKind を取得する 本 ExecutionContext の ExecutionKind を取得する |
java.lang.String |
getKindString()
|
java.lang.String |
getKindString(ExecutionKind kind)
ExecutionKind を文字列化する ExecutionKind で定義されている PERIODIC, EVENT_DRIVEN, OTHER を文字列化する。 |
ExecutionContextService |
getObjRef()
CORBA オブジェクト参照の取得 本オブジェクトの ExecutioncontextService としての CORBA オブジェ クト参照を取得する。 |
RTObject |
getOwner()
Ownerコンポーネントの参照を取得する このECのOwnerであるRTCの参照を取得する。 |
TimeValue |
getPeriod()
|
ExecutionContextProfile |
getProfile()
Profileを取得する {@.ja RTC::ExecutionContextProfile を取得する。 |
Properties |
getProperties()
Propertiesを取得する ExecutionContextProfile::properties を取得する。 |
double |
getRate()
ExecutionContext の実行周期(Hz)を取得する Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得す る。 |
void |
lock()
ExecutionContextProfileをロックする {@.ja このオブジェクトが管理する RTC::ExecutionContextProfile をロックする。 |
ReturnCode_t |
removeComponent(LightweightRTObject comp)
RTコンポーネントを参加者リストから削除する {@.ja 指定したRTコンポーネントを参加者リストから削除する。 |
ReturnCode_t |
setKind(ExecutionKind kind)
ExecutionKind を設定する この ExecutionContext の ExecutionKind を設定する |
void |
setObjRef(ExecutionContextService ec_ptr)
CORBA オブジェクトの設定 {@.ja ExecutioncontextService の CORBA オブジェクト参照をセットする。 |
ReturnCode_t |
setOwner(LightweightRTObject comp)
Ownerコンポーネントをセットする。 |
ReturnCode_t |
setPeriod(double period)
|
ReturnCode_t |
setPeriod(TimeValue period)
|
void |
setProperties(Properties props)
Propertiesをセットする ExecutionContextProfile::properties をセットする。 |
ReturnCode_t |
setRate(double rate)
ExecutionContext の実行周期(Hz)を設定する {@.ja Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定す る。 |
void |
unlock()
ExecutionContextProfileをアンロックする このオブジェクトが管理する RTC::ExecutionContextProfile をアンロッ クする。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
フィールドの詳細 |
---|
public static final double DEEFAULT_PERIOD
コンストラクタの詳細 |
---|
public ExecutionContextProfile(ExecutionKind kind)
デフォルトコンストラクタ プロファイルに以下の項目を設定する。 - kind : PERIODIC - rate : 0.0
public ExecutionContextProfile()
メソッドの詳細 |
---|
public void setObjRef(ExecutionContextService ec_ptr)
ExecutioncontextService の CORBA オブジェクト参照をセットする。 セットされると、それまでセットされていたオブジェクト参照は releaseされる。セットするオブジェクト参照は有効な参照でなければ ならない。
ec_ptr
- ExecutionContextServiceのCORBAオブジェクト
public ExecutionContextService getObjRef()
本オブジェクトの ExecutioncontextService としての CORBA オブジェ クト参照を取得する。
public ReturnCode_t setRate(double rate)
Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定す る。実行周期の変更は、DataFlowComponentAction の on_rate_changed によって各RTコンポーネントに伝達される。
rate
- 処理周期(単位:Hz)
public ReturnCode_t setPeriod(double period)
public ReturnCode_t setPeriod(TimeValue period)
public double getRate()
Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得す る。
public TimeValue getPeriod()
public final java.lang.String getKindString(ExecutionKind kind)
ExecutionKind で定義されている PERIODIC, EVENT_DRIVEN, OTHER を文字列化する。
kind
- ExecutionKind
public final java.lang.String getKindString()
public ReturnCode_t setKind(ExecutionKind kind)
この ExecutionContext の ExecutionKind を設定する
kind
- ExecutionKind
public ExecutionKind getKind()
本 ExecutionContext の ExecutionKind を取得する
public ReturnCode_t setOwner(LightweightRTObject comp)
このECのOwnerとなるRTCをセットする。
comp
- OwnerとなるRTコンポーネント
public final RTObject getOwner()
このECのOwnerであるRTCの参照を取得する。
public ReturnCode_t addComponent(LightweightRTObject comp)
指定したRTコンポーネントを参加者リストに追加する。追加されたRTコ ンポーネントは attach_context が呼ばれ、Inactive 状態に遷移する。 指定されたRTコンポーネントがnullの場合は、BAD_PARAMETER が返され る。指定されたRTコンポーネントが DataFlowComponent 以外の場合は、 BAD_PARAMETER が返される。
comp
- 追加対象RTコンポーネント
public ReturnCode_t removeComponent(LightweightRTObject comp)
指定したRTコンポーネントを参加者リストから削除する。削除された RTコンポーネントは detach_context が呼ばれる。指定されたRTコンポー ネントが参加者リストに登録されていない場合は、BAD_PARAMETER が返 される。
comp
- 削除対象RTコンポーネント
public final RTObject[] getComponentList()
現在登録されている参加者RTCのリストを取得する。この関数はコンポー ネントリストのメンバ変数への参照を返すので、リスト使用前に ExecutionContextProfile::lock() でロックし、リスト使用後は ExecutionContextProfile::unlock() でロックを開放しなければならな い。
public void setProperties(Properties props)
ExecutionContextProfile::properties をセットする。
props
- ExecutionContextProfile::properties にセットするプロパティー
public final Properties getProperties()
ExecutionContextProfile::properties を取得する。
public ExecutionContextProfile getProfile()
RTC::ExecutionContextProfile を取得する。取得した ExecutionContextProfile の所有権は呼び出し側にある。取得されたオ ブジェクトが不要になった場合、呼び出し側が開放する責任を負う。
public void lock()
このオブジェクトが管理する RTC::ExecutionContextProfile をロックする。 ロックが不要になった際にはunlock()でロックを解除しなければならない。
public void unlock()
このオブジェクトが管理する RTC::ExecutionContextProfile をアンロッ クする。
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |