ComponentObserverConsumer

java.lang.Object
- jp.go.aist.rtm.RTC.RTC.ComponentObserverConsumer

すべての実装されたインタフェース:

ObjectCreator<SdoServiceConsumerBase>, ObjectDestructor, SdoServiceConsumerBase, CallbackFunction
```
public class ComponentObserverConsumer
extends java.lang.Object
implements SdoServiceConsumerBase, CallbackFunction, ObjectCreator<SdoServiceConsumerBase>, ObjectDestructor
```
ComponentObserver モジュール
コンポーネントの各種状態をComponentObserverサービスに対してコールバックするためのクラス。ツール等、コンポーネントの状態変化を知りたいエンティティがサービスプロバイダを当該コンポーネントに対してセットすると、対応する本コンシューマがアタッチされ、コンポーネントの状態変化に応じて、update_status() オペレーションをSTATUS_KIND とヒントを引数に呼び出す。本機能は、OMG の FSM4RTC仕様 (formal/16-04-01) 7.2.4.2 ComponentObserver Interface に記述されている。 STATUS_KIND には以下の種類がある。
- - COMPONENT_PROFILE: コンポーネントのプロファイル情報が変化
- - RTC_STATUS : コンポーネントの状態 (Init, Alive) が変化
- - EC_STATUS : ECの状態 (Inavtive, Active, Error) が変化
- - PORT_PROFILE : ポートのプロファイルが変化
- - CONFIGURATION : コンフィギュレーションが変化
- - RTC_HEARTBEAT : RTCの生存確認のハートビード
- - EC_HEARTBEAT : ECの生存確認のハートビート
- - FSM_PROFILE : FSMのプロファイルが変化
- - FSM_STATUS : FSMの状態が変化
- - FSM_STRUCTURE : FSMの構造が変化
- - USER_DEFINED : ユーザ定義
\subsection COMPONENT_PROFILE COMPONENT_PROFILE
コンポーネントのプロファイル情報が変化した際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。(未実装)
\subsection RTC_STATUS RTC_STATUS
コンポーネントの状態 (Init, Alive) が変化した際にこのタグ名 (enum値)を第1引数にして update_status() オペレーションが呼び出される。厳密にはECの状態であるが、Inavtive, Active, Error, Finalize の 4つの状態に変化したことを検知することができる。以下の状態変化時に、それぞれヒントとして以下の文字列とともにコールバックされる。
- - onActivated 呼び出し成功時: ACTIVE:
- - onDeactivated 呼び出し成功時: INACTIVE:
- - onReset 呼び出し成功時: INACTIVE:
- - onAborting 呼び出し成功時: ERROR:
- - onFinalize 呼び出し成功時: FINALIZE:
\subsection EC_STATUS EC_STATUS
ECの状態 (Inavtive, Active, Error) が変化した際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。
\subsection PORT_PROFILE PORT_PROFILE ポートのプロファイルが変化した際にこのタグ名(enum値)を
第1引数にして update_status() オペレーションが呼び出される。
\subsection CONFIGURATION CONFIGURATION コンフィギュレーションが変化した際にこのタグ名(enum値)を
第1引数にして update_status() オペレーションが呼び出される。
\subsection RTC_HEARTBEAT RTC_HEARTBEAT RTCの生存確認のハートビードした際にこのタグ名(enum値)を
第1引数にして update_status() オペレーションが呼び出される。
\subsection EC_HEARTBEAT EC_HEARTBEAT
ECの生存確認のハートビートした際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。
\subsection FSM_PROFILE FSM_PROFILE
FSMのプロファイルが変化した際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。
\subsection FSM_STATUS FSM_STATUS
FSMの状態が変化した際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。
\subsection FSM_STRUCTURE FSM_STRUCTURE
FSMの構造が変化した際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。
\subsection USER_DEFINED USER_DEFINED
ユーザ定義した際にこのタグ名(enum値)を第1引数にして update_status() オペレーションが呼び出される。

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

ネストされたクラス
修飾子とタイプ	クラスと説明
`class`	`ComponentObserverConsumer.CompStatMsg` PostComponentActionListener class
`class`	`ComponentObserverConsumer.ConfigAction` ConfigActionListener
`class`	`ComponentObserverConsumer.ECAction` ExecutionContextActionListener
`class`	`ComponentObserverConsumer.FSMAction` FSMAction
`class`	`ComponentObserverConsumer.PortAction` PortActionListener

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

ComponentObserverConsumer()
ctor of ComponentObserverConsumer

コンストラクタ
コンストラクタと説明
`ComponentObserverConsumer()` ctor of ComponentObserverConsumer

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static void`	`ComponentObserverConsumerInit()` ComponentObserverConsumerInit
`SdoServiceConsumerBase`	`creator_()` creator_
`void`	`destructor_(java.lang.Object obj)` destructor_
`void`	`doOperate()` ハートビートをオブザーバに伝える
`protected void`	`ecHeartbeat()` ハートビートをオブザーバに伝える
`void`	`finalize()` 終了処理
`ServiceProfile`	`getProfile()` ServiceProfile を取得する
`boolean`	`init(RTObject_impl rtobj, ServiceProfile profile)` 初期化
`boolean`	`reinit(ServiceProfile profile)` 再初期化
`protected void`	`setComponentProfileListeners()` ComponentProfile状態変化リスナの設定
`protected void`	`setComponentStatusListeners()` RTC状態変化リスナの設定処理
`protected void`	`setConfigurationListeners()` Configuration状態変化リスナの設定
`protected void`	`setECHeartbeat(Properties prop)` ハートビートを設定する
`protected void`	`setExecutionContextListeners()` ECの状態変化リスナの設定
`protected void`	`setFSMProfileListeners()` FsmProfile状態変化リスナの設定
`protected void`	`setFSMStatusListeners()` FSM状態変化リスナの設定処理
`protected void`	`setFSMStructureListeners()` FsmStructure状態変化リスナの設定
`protected void`	`setListeners(Properties prop)` RTObjectへのリスナ接続処理
`protected void`	`setPortProfileListeners()` Portプロファイル変化リスナの設定処理
`protected void`	`setRTCHeartbeat(Properties prop)` ハートビートを設定する
`protected <DataType> void`	`switchListeners(boolean next, DataRef<java.lang.Boolean> pre, DataType obj, java.lang.String setfunc, java.lang.String unsetfunc)` リスナ接続・切断スイッチング処理
`protected java.lang.String`	`toString(StatusKind kind)` Kindを文字列へ変換する
`protected void`	`unsetComponentProfileListeners()` ComponentProfile状態変化リスナの解除
`protected void`	`unsetComponentStatusListeners()` RTC状態変化リスナの解除処理
`protected void`	`unsetConfigurationListeners()` Configuration状態変化リスナの解除
`protected void`	`unsetECHeartbeat()` ハートビートを解除する
`protected void`	`unsetExecutionContextListeners()` ECの状態変化リスナの解除
`protected void`	`unsetFSMProfileListeners()` FsmProfile状態変化リスナの解除
`protected void`	`unsetFSMStatusListeners()` FSM状態変化リスナの解除処理
`protected void`	`unsetFSMStructureListeners()` FsmStructure状態変化リスナの解除
`protected void`	`unsetPortProfileListeners()` Portプロファイル変化リスナの解除処理
`protected void`	`unsetRTCHeartbeat()` ハートビートを解除する
`protected void`	`updateStatus(StatusKind statuskind, java.lang.String msg)` リモートオブジェクトコール

クラスから継承されたメソッド java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - ComponentObserverConsumer
```
public ComponentObserverConsumer()
```
    ctor of ComponentObserverConsumer
- メソッドの詳細
  - init
```
public boolean init(RTObject_impl rtobj,
                    ServiceProfile profile)
```
    初期化
    
    定義:
    
    init インタフェース内 SdoServiceConsumerBase
    
    パラメータ:
    
    rtobj - このオブジェクトがインスタンス化された RTC
    
    profile - 外部から与えられた SDO ServiceProfile
    
    戻り値:
    
    与えられた SDO Service や ServiceProfile が不正の場合 false
  - reinit
```
public boolean reinit(ServiceProfile profile)
```
    再初期化
    
    定義:
    
    reinit インタフェース内 SdoServiceConsumerBase
    
    パラメータ:
    
    profile - 新たに与えられた SDO ServiceProfile
    
    戻り値:
    
    不正な ServiceProfile が与えられた場合は false
  - getProfile
```
public final ServiceProfile getProfile()
```
    ServiceProfile を取得する
    
    定義:
    
    getProfile インタフェース内 SdoServiceConsumerBase
    
    戻り値:
    
    このオブジェクトが保持している ServiceProfile
  - finalize
```
public void finalize()
```
    終了処理
    
    定義:
    
    finalize インタフェース内 SdoServiceConsumerBase
    
    オーバーライド:
    
    finalize クラス内 java.lang.Object
  - updateStatus
```
protected void updateStatus(StatusKind statuskind,
                            java.lang.String msg)
```
    リモートオブジェクトコール
  - toString
```
protected final java.lang.String toString(StatusKind kind)
```
    Kindを文字列へ変換する
  - setListeners
```
protected void setListeners(Properties prop)
```
    RTObjectへのリスナ接続処理
  - switchListeners
```
protected <DataType> void switchListeners(boolean next,
                                          DataRef<java.lang.Boolean> pre,
                                          DataType obj,
                                          java.lang.String setfunc,
                                          java.lang.String unsetfunc)
```
    リスナ接続・切断スイッチング処理
  - doOperate
```
public void doOperate()
```
    ハートビートをオブザーバに伝える
    
    定義:
    
    doOperate インタフェース内 CallbackFunction
  - setRTCHeartbeat
```
protected void setRTCHeartbeat(Properties prop)
```
    ハートビートを設定する
  - unsetRTCHeartbeat
```
protected void unsetRTCHeartbeat()
```
    ハートビートを解除する
  - ecHeartbeat
```
protected void ecHeartbeat()
```
    ハートビートをオブザーバに伝える
  - setECHeartbeat
```
protected void setECHeartbeat(Properties prop)
```
    ハートビートを設定する
  - unsetECHeartbeat
```
protected void unsetECHeartbeat()
```
    ハートビートを解除する
  - setComponentStatusListeners
```
protected void setComponentStatusListeners()
```
    RTC状態変化リスナの設定処理
  - unsetComponentStatusListeners
```
protected void unsetComponentStatusListeners()
```
    RTC状態変化リスナの解除処理
  - setFSMStatusListeners
```
protected void setFSMStatusListeners()
```
    FSM状態変化リスナの設定処理
  - unsetFSMStatusListeners
```
protected void unsetFSMStatusListeners()
```
    FSM状態変化リスナの解除処理
  - setPortProfileListeners
```
protected void setPortProfileListeners()
```
    Portプロファイル変化リスナの設定処理
  - unsetPortProfileListeners
```
protected void unsetPortProfileListeners()
```
    Portプロファイル変化リスナの解除処理
  - setExecutionContextListeners
```
protected void setExecutionContextListeners()
```
    ECの状態変化リスナの設定
  - unsetExecutionContextListeners
```
protected void unsetExecutionContextListeners()
```
    ECの状態変化リスナの解除
  - setComponentProfileListeners
```
protected void setComponentProfileListeners()
```
    ComponentProfile状態変化リスナの設定
  - unsetComponentProfileListeners
```
protected void unsetComponentProfileListeners()
```
    ComponentProfile状態変化リスナの解除
  - setFSMProfileListeners
```
protected void setFSMProfileListeners()
```
    FsmProfile状態変化リスナの設定
  - unsetFSMProfileListeners
```
protected void unsetFSMProfileListeners()
```
    FsmProfile状態変化リスナの解除
  - setFSMStructureListeners
```
protected void setFSMStructureListeners()
```
    FsmStructure状態変化リスナの設定
  - unsetFSMStructureListeners
```
protected void unsetFSMStructureListeners()
```
    FsmStructure状態変化リスナの解除
  - setConfigurationListeners
```
protected void setConfigurationListeners()
```
    Configuration状態変化リスナの設定
  - unsetConfigurationListeners
```
protected void unsetConfigurationListeners()
```
    Configuration状態変化リスナの解除
  - creator_
```
public SdoServiceConsumerBase creator_()
```
    creator_
    
    定義:
    
    creator_ インタフェース内 ObjectCreator<SdoServiceConsumerBase>
    
    戻り値:
    
    Object Created instances
  - destructor_
```
public void destructor_(java.lang.Object obj)
```
    destructor_
    
    定義:
    
    destructor_ インタフェース内 ObjectDestructor
    
    パラメータ:
    
    obj - The target instances for destruction
  - ComponentObserverConsumerInit
```
public static void ComponentObserverConsumerInit()
```
    ComponentObserverConsumerInit

クラス ComponentObserverConsumer

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

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

ComponentObserverConsumer

メソッドの詳細

init

reinit

getProfile

finalize

updateStatus

toString

setListeners

switchListeners

doOperate

setRTCHeartbeat

unsetRTCHeartbeat

ecHeartbeat

setECHeartbeat

unsetECHeartbeat

setComponentStatusListeners

unsetComponentStatusListeners

setFSMStatusListeners

unsetFSMStatusListeners

setPortProfileListeners

unsetPortProfileListeners

setExecutionContextListeners

unsetExecutionContextListeners

setComponentProfileListeners

unsetComponentProfileListeners

setFSMProfileListeners

unsetFSMProfileListeners

setFSMStructureListeners

unsetFSMStructureListeners

setConfigurationListeners

unsetConfigurationListeners

creator_

destructor_

ComponentObserverConsumerInit