jp.go.aist.rtm.RTC.executionContext

インタフェース ExecutionContextBase

すべてのスーパーインタフェース:

ECNewDeleteFunc

既知の実装クラスのリスト:

ExtTrigExecutionContext, OpenHRPExecutionContext, PeriodicExecutionContext

public interface ExecutionContextBase
extends ECNewDeleteFunc

Periodic Sampled Data Processing(周期実行用)ExecutionContextのベースとなる 抽象クラスです。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static class	ExecutionContextBase.transitionModeHolder transitionMode保持用クラスです。

メソッドのサマリー

メソッド

修飾子とタイプ	メソッドと説明
ReturnCode_t	bindComponent(RTObject_impl rtc) bindComponent
RTObject[]	getComponentList() RTコンポーネントの参加者リストを取得する 現在登録されている参加者RTCのリストを取得する。
java.lang.String	getKindString(ExecutionKind kind) ExecutionKind を文字列化する RTC::ExecutionKind で定義されている PERIODIC, EVENT_DRIVEN, OTHER を文字列化する。
ExecutionContextService	getObjRef() CORBA オブジェクト参照の取得 本オブジェクトの ExecutioncontextService としての CORBA オブジェ クト参照を取得する。
RTObject	getOwner() Ownerコンポーネントの参照を取得する このECのOwnerであるRTCの参照を取得する。
ExecutionContextProfile	getProfile() Profileを取得する ExecutionContextProfile を取得する。
Properties	getProperties() Propertiesを取得する ExecutionContextProfile::properties を取得する。
double	getRate() ExecutionContext の実行周期(Hz)を取得する Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得す る。
void	init(Properties props) ExecutionContextクラスの初期化関数
void	invokeWorker()
void	invokeWorkerDo()
void	invokeWorkerPostDo()
void	invokeWorkerPreDo()
boolean	isAllCurrentState(LifeCycleState state)
boolean	isAllNextState(LifeCycleState state)
boolean	isOneOfCurrentState(LifeCycleState state)
boolean	isOneOfNextState(LifeCycleState state)
ReturnCode_t	onActivated(RTObjectStateMachine comp, long count)
ReturnCode_t	onActivating(LightweightRTObject comp)
ReturnCode_t	onAddedComponent(LightweightRTObject rtobj)
ReturnCode_t	onAddingComponent(LightweightRTObject rtobj)
ReturnCode_t	onDeactivated(RTObjectStateMachine comp, long count)
ReturnCode_t	onDeactivating(LightweightRTObject comp)
LifeCycleState	onGetComponentState(LifeCycleState state)
ExecutionKind	onGetKind(ExecutionKind kind)
ExecutionContextProfile	onGetProfile(ExecutionContextProfile profile)
double	onGetRate(double rate)
ReturnCode_t	onRemovedComponent(LightweightRTObject rtobj)
ReturnCode_t	onRemovingComponent(LightweightRTObject rtobj)
ReturnCode_t	onReset(RTObjectStateMachine comp, long count)
ReturnCode_t	onResetting(LightweightRTObject comp)
ReturnCode_t	onSetRate(double rate)
double	onSettingRate(double rate)
ReturnCode_t	onStarted()
ReturnCode_t	onStopped()
ReturnCode_t	onStopping()
ReturnCode_t	onWaitingActivated(RTObjectStateMachine comp, long count) onWaitingActivated() template function
ReturnCode_t	onWaitingDeactivated(RTObjectStateMachine comp, long count) onWaitingDeactivated() template function
ReturnCode_t	onWaitingReset(RTObjectStateMachine comp, long count) onWaitingReset() template function
boolean	setExecutionRate(Properties props) Propertiesから実行コンテキストをセットする
ReturnCode_t	setKind(ExecutionKind kind) ExecutionKind を設定する この ExecutionContext の ExecutionKind を設定する
void	setObjRef(ExecutionContextService ref) CORBA オブジェクトの設定 本オブジェクトの ExecutioncontextService としての CORBA オブジェ クトを設定する。
ReturnCode_t	setOwner(LightweightRTObject comp) Ownerコンポーネントをセットする。
void	setProperties(Properties props) Propertiesをセットする ExecutionContextProfile::properties をセットする。
ReturnCode_t	setRate(double rate) ExecutionContext の実行周期(Hz)を設定する {@.ja Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定す る。
boolean	setTimeout(Properties props, java.lang.String key, TimeValue timevalue) Propertiesから状態遷移Timeoutをセットする
boolean	setTransitionMode(Properties props, java.lang.String key, ExecutionContextBase.transitionModeHolder flag) Propertiesから状態遷移モードをセットする

インタフェースから継承されたメソッド jp.go.aist.rtm.RTC.executionContext.ECNewDeleteFunc

ECDeleteFunc, ECNewFunc

メソッドの詳細

init

void init(Properties props)

ExecutionContextクラスの初期化関数

setObjRef

void setObjRef(ExecutionContextService ref)

CORBA オブジェクトの設定

本オブジェクトの ExecutioncontextService としての CORBA オブジェ クトを設定する。

パラメータ:

ref - オブジェクトリファレンス

bindComponent

ReturnCode_t bindComponent(RTObject_impl rtc)

bindComponent

パラメータ:

rtc - RTObject

戻り値:

ReturnCode_t

getObjRef

ExecutionContextService getObjRef()

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

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

戻り値:

CORBA オブジェクト参照

setRate

ReturnCode_t setRate(double rate)

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

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

パラメータ:

rate - 処理周期(単位:Hz)

戻り値:

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

getRate

double getRate()

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

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

戻り値:

処理周期(単位:Hz)

getKindString

java.lang.String getKindString(ExecutionKind kind)

ExecutionKind を文字列化する

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

パラメータ:

kind - ExecutionKind

戻り値:

文字列化されたExecutionKind

setKind

ReturnCode_t setKind(ExecutionKind kind)

ExecutionKind を設定する

この ExecutionContext の ExecutionKind を設定する

パラメータ:

kind - ExecutionKind

setOwner

ReturnCode_t setOwner(LightweightRTObject comp)

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

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

パラメータ:

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

戻り値:

ReturnCode_t 型のリターンコード

getOwner

RTObject getOwner()

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

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

戻り値:

OwnerRTコンポーネントの参照

getComponentList

RTObject[] getComponentList()

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

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

戻り値:

参加者RTCのリスト

setProperties

void setProperties(Properties props)

Propertiesをセットする

ExecutionContextProfile::properties をセットする。

パラメータ:

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

getProperties

Properties getProperties()

Propertiesを取得する

ExecutionContextProfile::properties を取得する。

戻り値:

Propertiesに変換された ExecutionContextProfile::properties

getProfile

ExecutionContextProfile getProfile()

Profileを取得する

ExecutionContextProfile を取得する。

戻り値:

ExecutionContextProfile

setExecutionRate

boolean setExecutionRate(Properties props)

Propertiesから実行コンテキストをセットする

パラメータ:

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

setTransitionMode

boolean setTransitionMode(Properties props,
                        java.lang.String key,
                        ExecutionContextBase.transitionModeHolder flag)

Propertiesから状態遷移モードをセットする

パラメータ:

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

key -

flag -

setTimeout

boolean setTimeout(Properties props,
                 java.lang.String key,
                 TimeValue timevalue)

Propertiesから状態遷移Timeoutをセットする

パラメータ:

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

key -

timevalue -

onStarted

ReturnCode_t onStarted()

onStopping

ReturnCode_t onStopping()

onStopped

ReturnCode_t onStopped()

onGetRate

double onGetRate(double rate)

onSettingRate

double onSettingRate(double rate)

onSetRate

ReturnCode_t onSetRate(double rate)

onAddingComponent

ReturnCode_t onAddingComponent(LightweightRTObject rtobj)

onAddedComponent

ReturnCode_t onAddedComponent(LightweightRTObject rtobj)

onRemovingComponent

ReturnCode_t onRemovingComponent(LightweightRTObject rtobj)

onRemovedComponent

ReturnCode_t onRemovedComponent(LightweightRTObject rtobj)

onActivating

ReturnCode_t onActivating(LightweightRTObject comp)

onActivated

ReturnCode_t onActivated(RTObjectStateMachine comp,
                       long count)

onDeactivating

ReturnCode_t onDeactivating(LightweightRTObject comp)

onDeactivated

ReturnCode_t onDeactivated(RTObjectStateMachine comp,
                         long count)

onResetting

ReturnCode_t onResetting(LightweightRTObject comp)

onReset

ReturnCode_t onReset(RTObjectStateMachine comp,
                   long count)

onGetComponentState

LifeCycleState onGetComponentState(LifeCycleState state)

onGetKind

ExecutionKind onGetKind(ExecutionKind kind)

onGetProfile

ExecutionContextProfile onGetProfile(ExecutionContextProfile profile)

onWaitingActivated

ReturnCode_t onWaitingActivated(RTObjectStateMachine comp,
                              long count)

onWaitingActivated() template function

onWaitingDeactivated

ReturnCode_t onWaitingDeactivated(RTObjectStateMachine comp,
                                long count)

onWaitingDeactivated() template function

onWaitingReset

ReturnCode_t onWaitingReset(RTObjectStateMachine comp,
                          long count)

onWaitingReset() template function

isAllCurrentState

boolean isAllCurrentState(LifeCycleState state)

isAllNextState

boolean isAllNextState(LifeCycleState state)

isOneOfCurrentState

boolean isOneOfCurrentState(LifeCycleState state)

isOneOfNextState

boolean isOneOfNextState(LifeCycleState state)

invokeWorker

void invokeWorker()

invokeWorkerPreDo

void invokeWorkerPreDo()

invokeWorkerDo

void invokeWorkerDo()

invokeWorkerPostDo

void invokeWorkerPostDo()