jp.go.aist.rtm.RTC
クラス RTObject_impl

java.lang.Object
  上位を拡張 org.omg.PortableServer.Servant
      上位を拡張 OpenRTM.DataFlowComponentPOA
          上位を拡張 jp.go.aist.rtm.RTC.RTObject_impl
すべての実装されたインタフェース:
SDOOperations, SDOSystemElementOperations, org.omg.CORBA.portable.InvokeHandler, ComponentActionOperations, DataFlowComponentActionOperations, DataFlowComponentOperations, LightweightRTObjectOperations, RTObjectOperations
直系の既知のサブクラス:
DataFlowComponentBase, PeriodicECSharedComposite_impl

public class RTObject_impl
extends DataFlowComponentPOA

DataFlowComponentのベースクラスです。 ユーザが新たなRTコンポーネントを作成する場合は、このクラスを拡張します。


入れ子のクラスの概要
(package private)  class RTObject_impl.deactivate_comps
           Functor to deactivate RTC
(package private)  class RTObject_impl.ec_copy
          ExecutionContext コピー用ファンクタ
(package private)  class RTObject_impl.ec_find
          ExecutionContext 検索用ファンクタ
(package private)  class RTObject_impl.nv_name
          RTコンポーネント検索用ヘルパークラス
 
フィールドの概要
(package private) static java.lang.String[] default_conf
          RTコンポーネントのデフォルト・コンポーネント・プロファイルです。
static int ECOTHER_OFFSET
           
protected  ConfigAdmin m_configsets
          RTC のコンフィギュレーション管理オブジェクト
protected  boolean m_created
          生成済みフラグ
protected  java.util.Vector<ExecutionContextBase> m_eclist
           List of ExecutionContextBase
protected  ExecutionContextServiceListHolder m_ecMine
          自分がownerのExecutionContextService のリスト
protected  ExecutionContextServiceListHolder m_ecOther
          参加しているExecutionContextService のリスト
protected  java.util.Vector<InPortBase> m_inports
           List of InPortBase.
protected  RTObject m_objref
          CORBAオブジェクトへの参照
protected  java.util.Vector<OutPortBase> m_outports
           List of OutPortBase.
protected  Manager m_pManager
          Manager オブジェクト
protected  org.omg.CORBA.ORB m_pORB
          ORB
protected  PortAdmin m_portAdmin
          Port のオブジェクトリファレンスのリスト
protected  org.omg.PortableServer.POA m_pPOA
          POA
protected  ComponentProfile m_profile
          ComponentProfile
protected  Properties m_properties
          RTC のプロパティ
protected  Configuration m_pSdoConfig
          SDO Configuration
protected  Configuration_impl m_pSdoConfigImpl
          SDO Configuration Interface へのポインタ
protected  boolean m_readAll
           flag for readAll()
protected  boolean m_readAllCompletion
           flag for readAll()
protected  OrganizationListHolder m_sdoOrganizations
          SDO organization
protected  OrganizationListHolder m_sdoOwnedOrganizations
          SDO organization リスト
protected  NVListHolder m_sdoStatus
          SDO Status
protected  ServiceProfileListHolder m_sdoSvcProfiles
          SDOService のプロファイルリスト
protected  boolean m_writeAll
           flag for writeAll()
protected  boolean m_writeAllCompletion
           flag for writeAll().
protected  Logbuf rtcout
          Logging用フォーマットオブジェクト
 
コンストラクタの概要
RTObject_impl(Manager manager)
           Constructor
RTObject_impl(org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa)
           Constructor
 
メソッドの概要
 ReturnCode_t _finalize()
          RTコンポーネントを終了します。
このオペレーション呼び出しの結果として、ComponentAction::on_finalize コールバック関数が呼ばれます。
制約
 DataFlowComponent _this()
           _this
 boolean addInPort(java.lang.String name, InPortBase inport)
           [local interface] Register DataInPort.
 boolean addOutPort(java.lang.String name, OutPortBase outport)
           [local interface] Register DataOutPort.
 boolean addPort(CorbaPort port)
           [local interface] Register Port
 boolean addPort(PortBase port)
           [local interface] Register Port
 boolean addPort(PortService port)
           [local interface] Register Port
 int attach_context(ExecutionContext exec_context)
          [CORBA interface] 当該コンポーネントをExecutionContextにattachします。
 int bindContext(ExecutionContext exec_context)
           bindContext
 boolean bindParameter(java.lang.String param_name, ValueHolder var, java.lang.String def_val)
          コンフィギュレーション・パラメータをbindします。
 void deletePort(CorbaPort port)
           [local interface] Unregister Port
 void deletePort(PortBase port)
           [local interface] Unregister Port
 void deletePort(PortService port)
           [local interface] Unregister Port
 void deletePortByName(java.lang.String port_name)
          [local interface] 名称によって指定された Port の登録を削除します。
 ReturnCode_t detach_context(int ec_id)
          [CORBA interface] 当該コンポーネントをExecutionContextからdetachします。
 ReturnCode_t exit()
          RTコンポーネントを停止し、そのコンテンツとともに終了します。
この RTC がオーナーであるすべての実行コンテキストが停止されます。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e.
 void finalizeContexts()
          登録されているすべてのContextの登録を削除します。
 void finalizePorts()
           Unregister All Ports
 ComponentProfile get_component_profile()
           [RTObject CORBA interface] Get RTC's profile
 Configuration get_configuration()
          [CORBA interface] Configuration オブジェクト を取得します。
このオペレーションは Configuration interface への参照を返します。 Configuration interface は各 SDO を管理するためのインターフェースのひとつです。 このインターフェースは DeviceProfile, ServiceProfile, Organization で定義された SDO の属性値を設定するために使用されます。 Configuration インターフェースの詳細については、OMG SDO specification の 2.3.5節, p.2-24 を参照してください。
 int get_context_handle(ExecutionContext cxt)
          [CORBA interface] LightweightRTObject
 ExecutionContext get_context(int ec_id)
          [CORBA interface] ExecutionContextを取得します。
 DeviceProfile get_device_profile()
          [CORBA interface] SDO DeviceProfile リストを取得します。
SDO の DeviceProfile を返すオペレーション。 SDO がハードウエアデバイスに関連付けられていない場合には、空の DeviceProfile を返します。 このオペレーションは以下の型の例外を発生させる場合があります。
 Monitoring get_monitoring()
          [CORBA interface] Monitoring オブジェクト を取得します。
このオペレーションは Monitoring interface への参照を返します。 Monitoring interface は SDO が管理するインターフェースの一つです。 このインターフェースは SDO のプロパティをモニタリングするために使用されます。 Monitoring interface の詳細については OMG SDO specification の 2.3.7節 "Monitoring Interface" p.2-35 を参照してください。
 Organization[] get_organizations()
          [CORBA interface] Organization リスト を取得します。
SDO は0個以上の Organization (組織)に所属することができます。 もし SDO が1個以上の Organization に所属している場合、このオペレーションは所属する Organization のリストを返します。SDO が どの Organization にも所属していない 場合には、空のリストが返されます。
 ExecutionContext[] get_owned_contexts()
          [CORBA interface] ExecutionContextListを取得します。
 Organization[] get_owned_organizations()
          [CORBA interface] Organization リストを取得します。
SDOSystemElement は0個もしくはそれ以上の Organization を所有することが 出来ます。 SDOSystemElement が1つ以上の Organization を所有している場合 には、このオペレーションは所有する Organization のリストを返します。 もしOrganizationを一つも所有していないければ空のリストを返します。
 ExecutionContext[] get_participating_contexts()
          [CORBA interface] LightweightRTObject
 PortService[] get_ports()
          [RTObject CORBA interface] 当該コンポーネントが保有するポートの参照を取得します。
 java.lang.String get_sdo_id()
          [CORBA interface] SDO IDを取得します。
SDO ID を返すオペレーション。 このオペレーションは以下の型の例外を発生させる場合があります。
 SDOService get_sdo_service(java.lang.String id)
          [CORBA interface] 指定された SDO Service を取得します。
このオペレーションは引数 "id" で指定された名前によって区別される SDO の Service へのオブジェクト参照を返します。 SDO により提供される Service はそれぞれ一意の識別子により区別されます。
 java.lang.String get_sdo_type()
          [CORBA interface] SDO タイプを取得します。
SDO Type を返すオペレーション。 このオペレーションは以下の型の例外を発生させる場合があります。
 ServiceProfile get_service_profile(java.lang.String id)
          [CORBA interface] 特定のServiceProfile を取得します。
引数 "id" で指定された名前のサービスの ServiceProfile を返します。
 ServiceProfile[] get_service_profiles()
          [CORBA interface] SDO ServiceProfile を取得します。
SDO が所有している Service の ServiceProfile を返すオペレーション。 SDO がサービスを一つも所有していない場合には、空のリストを返します。 このオペレーションは以下の型の例外を発生させる場合があります。
 NameValue[] get_status_list()
          [CORBA interface] SDO Status リスト を取得します。
このオペレーションは SDO のステータスを表す NVList を返します
 org.omg.CORBA.Any get_status(java.lang.String name)
          [CORBA interface] SDO Status を取得します。
このオペレーションは 引数で指定された SDO のステータスを返します
 java.lang.String getCategory()
          当該オブジェクトのカテゴリを取得します。
 java.lang.String getInstanceName()
          当該オブジェクトのインスタンス名を取得します。
 java.lang.String[] getNamingNames()
          当該オブジェクトのNaming Seriveへの登録名を取得します。
 RTObject getObjRef()
          CORBAオブジェクト参照を取得します。
 Properties getProperties()
          [local interface] RTC のプロパティを取得します。
RTC が保持しているプロパティを返します。 RTCがプロパティを持たない場合は空のプロパティが返されます。
 java.lang.String getTypeName()
          当該オブジェクトの型名を取得します。
 ReturnCode_t initialize()
          RTコンポーネントを初期化します。
このオペレーション呼び出しの結果として、ComponentAction::on_initialize コールバック関数が呼ばれます。
制約
Created状態にいるときにのみ、初期化が行われます。他の状態にいる場合には ReturnCode_t::PRECONDITION_NOT_MET が返され呼び出しは失敗します。 このオペレーションはRTCのミドルウエアから呼ばれることを想定しており、 アプリケーション開発者は直接このオペレーションを呼ぶことは想定 されていません。
 boolean is_alive(ExecutionContext exec_context)
          RTコンポーネントがAlive状態であるか判断します。
RTコンポーネントがAliveであるかどうかは、 ExecutionContextの状態(Inactive,Active,Error)とは独立しています。 1つのRTコンポーネントが、複数のExecutionContextにattachされる場合もあるため、 ExecutionContextの状態が混在する場合 (ExecutionContext1に対してはActive、ExecutionContext2に対してはInactiveなど) があるためです。
 ReturnCode_t on_aborting(int ec_id)
          [ComponentAction interface] 当該コンポーネントのAbort時に呼び出されます。
 ReturnCode_t on_activated(int ec_id)
          [ComponentAction interface] 当該コンポーネントのActivate時に呼び出されます。
 ReturnCode_t on_deactivated(int ec_id)
          [ComponentAction interface] 当該コンポーネントのDeactivate時に呼び出されます。
 ReturnCode_t on_error(int ec_id)
          [ComponentAction interface] 当該コンポーネントがError状態にいる間、呼び出されます。
 ReturnCode_t on_execute(int ec_id)
           [DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC
 ReturnCode_t on_finalize()
          [ComponentAction interface] 当該コンポーネントの終了時に呼び出されます。
 ReturnCode_t on_initialize()
           [ComponentAction CORBA interface] Initialize RTC
 ReturnCode_t on_rate_changed(int ec_id)
          [ComponentAction interface] 当該コンポーネントがattachされているExecutionContextの実行周期が変更になった時に呼び出されます。
 ReturnCode_t on_reset(int ec_id)
          [ComponentAction interface] 当該コンポーネントのReset時に呼び出されます。
 ReturnCode_t on_shutdown(int ec_id)
          [ComponentAction interface] 当該コンポーネントのattachされているExecutionContextの実行終了時に呼び出されます。
 ReturnCode_t on_startup(int ec_id)
          [ComponentAction interface] 当該コンポーネントのattachされているExecutionContextの実行開始時に呼び出されます。
 ReturnCode_t on_state_update(int ec_id)
          [ComponentAction interface] 当該コンポーネントがAvtive状態の間、on_executeの後に呼び出されます。
protected  ReturnCode_t onAborting(int ec_id)
          RTコンポーネントにエラーが発生した時(Active->Error)に呼び出されるアクションです。
protected  ReturnCode_t onActivated(int ec_id)
          RTコンポーネントのActivate時(Inactive->Active)に呼び出されるアクションです。
protected  ReturnCode_t onDeactivated(int ec_id)
          RTコンポーネントのDeactivate時(Active->Inactive)に呼び出されるアクションです。
protected  ReturnCode_t onError(int ec_id)
          RTコンポーネントがError状態の間呼び出されるアクションです。
protected  ReturnCode_t onExecute(int ec_id)
          RTコンポーネントがActivate状態の間呼び出されるアクションです。
protected  ReturnCode_t onFinalize()
          コンポーネント破棄時(Alive->Exit)に呼び出されるアクションです。
protected  ReturnCode_t onInitialize()
          コンポーネント生成時(Created->Alive)に呼び出されるアクションです。
protected  ReturnCode_t onRateChanged(int ec_id)
          ExecutionContextの実行周期が変更になった時に呼び出されるアクションです。
protected  ReturnCode_t onReset(int ec_id)
          RTコンポーネントをresetする際(Error->Inactive)に呼び出されるアクションです。
protected  ReturnCode_t onShutdown(int ec_id)
          ExecutionContextの動作終了時(Started->Stopped)に呼び出されるアクションです。
protected  ReturnCode_t onStartup(int ec_id)
          ExecutionContextの動作開始時(Stopped->Started)に呼び出されるアクションです。
protected  ReturnCode_t onStateUpdate(int ec_id)
          RTコンポーネントがActivate状態の間、 on_executeの続いて呼び出されるアクションです。
 boolean readAll()
           Readout the value from All InPorts.
<DataType,Buffer>
void
registerInPort(java.lang.Class<DataType> DATA_TYPE_CLASS, java.lang.String name, InPort<DataType> inport)
          [local interface] DataInPort を登録します。
RTC が保持するDataInPortを登録します。
 void registerInPort(java.lang.String name, InPortBase inport)
           [local interface] Register DataInPort.
<DataType,Buffer>
void
registerOutPort(java.lang.Class<DataType> DATA_TYPE_CLASS, java.lang.String name, OutPort<DataType> outport)
          [local interface] DataOutPort を登録します。
RTC が保持するDataOutPortを登録します。
 void registerOutPort(java.lang.String name, OutPortBase outport)
           [local interface] Register DataOutPort
 void registerPort(CorbaPort port)
           [local interface] Register Port
 void registerPort(PortBase port)
           [local interface] Register Port
 void registerPort(PortService port)
           [local interface] Register Port
 boolean removeInPort(InPortBase port)
           [local interface] Unregister InPort
 boolean removeOutPort(OutPortBase port)
           [local interface] Unregister OutPort.
 boolean removePort(CorbaPort port)
           [local interface] Unregister Port
 boolean removePort(PortBase port)
           [local interface] Unregister Port
 boolean removePort(PortService port)
           [local interface] Unregister Port
 void setInstanceName(java.lang.String instance_name)
          当該オブジェクトのインスタンス名を設定します。
 void setObjRef(RTObject rtobj)
          CORBAオブジェクト参照を設定します。
 void setProperties(Properties prop)
          [local interface] RTC のプロパティを設定します。
RTコンポーネント が保持すべきプロパティを設定します。 与えられるプロパティは、ComponentProfile 等に設定されるべき情報を持たなければなりません。 このオペレーションは通常 RTコンポーネント が初期化される際に Manager から 呼ばれることを意図しています。
 void setReadAll()
           
 void setReadAll(boolean read)
           
 void setReadAll(boolean read, boolean completion)
           Set whether to execute the readAll() method.
 void setWriteAll()
           
 void setWriteAll(boolean write)
           
 void setWriteAll(boolean write, boolean completion)
           @brief Set whether to execute the writeAll() method.
protected  void shutdown()
          当該コンポーネントを終了します。
protected  void syncAttributesByProperties()
           syncAttributesByProperties
 void updateParameters(java.lang.String config_set)
          コンフィギュレーション・パラメータを更新します。
 boolean writeAll()
           The write() method of all OutPorts are called.
 
クラス OpenRTM.DataFlowComponentPOA から継承されたメソッド
_all_interfaces, _invoke, _this
 
クラス org.omg.PortableServer.Servant から継承されたメソッド
_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

default_conf

static final java.lang.String[] default_conf

RTコンポーネントのデフォルト・コンポーネント・プロファイルです。


ECOTHER_OFFSET

public static final int ECOTHER_OFFSET
関連項目:
定数フィールド値

m_pManager

protected Manager m_pManager

Manager オブジェクト


m_pORB

protected org.omg.CORBA.ORB m_pORB

ORB


m_pPOA

protected org.omg.PortableServer.POA m_pPOA

POA


m_sdoOwnedOrganizations

protected OrganizationListHolder m_sdoOwnedOrganizations

SDO organization リスト


m_sdoSvcProfiles

protected ServiceProfileListHolder m_sdoSvcProfiles
SDOService のプロファイルリスト


m_pSdoConfigImpl

protected Configuration_impl m_pSdoConfigImpl
SDO Configuration Interface へのポインタ


m_pSdoConfig

protected Configuration m_pSdoConfig
SDO Configuration


m_sdoOrganizations

protected OrganizationListHolder m_sdoOrganizations
SDO organization


m_sdoStatus

protected NVListHolder m_sdoStatus
SDO Status


m_profile

protected ComponentProfile m_profile
ComponentProfile


m_objref

protected RTObject m_objref
CORBAオブジェクトへの参照


m_portAdmin

protected PortAdmin m_portAdmin
Port のオブジェクトリファレンスのリスト


m_ecMine

protected ExecutionContextServiceListHolder m_ecMine
自分がownerのExecutionContextService のリスト


m_eclist

protected java.util.Vector<ExecutionContextBase> m_eclist
List of ExecutionContextBase


m_ecOther

protected ExecutionContextServiceListHolder m_ecOther
参加しているExecutionContextService のリスト


m_created

protected boolean m_created
生成済みフラグ


m_properties

protected Properties m_properties
RTC のプロパティ


m_configsets

protected ConfigAdmin m_configsets
RTC のコンフィギュレーション管理オブジェクト


rtcout

protected Logbuf rtcout

Logging用フォーマットオブジェクト


m_inports

protected java.util.Vector<InPortBase> m_inports
List of InPortBase.


m_outports

protected java.util.Vector<OutPortBase> m_outports
List of OutPortBase.


m_readAll

protected boolean m_readAll
flag for readAll()


m_writeAll

protected boolean m_writeAll
flag for writeAll()


m_readAllCompletion

protected boolean m_readAllCompletion
flag for readAll()

true:Even if the error occurs during readAll(), it executes it to the last minute. false:End when error occurs during readAll().


m_writeAllCompletion

protected boolean m_writeAllCompletion
flag for writeAll().

true:Even if the error occurs during writeAll(), it executes it to the last minute. false:End when error occurs during writeAll().

コンストラクタの詳細

RTObject_impl

public RTObject_impl(Manager manager)
Constructor

パラメータ:
manager - Manager object

RTObject_impl

public RTObject_impl(org.omg.CORBA.ORB orb,
                     org.omg.PortableServer.POA poa)
Constructor

パラメータ:
orb - ORB
poa - POA
メソッドの詳細

_this

public DataFlowComponent _this()

_this

オーバーライド:
クラス DataFlowComponentPOA 内の _this
戻り値:
DataFlowComponent

onInitialize

protected ReturnCode_t onInitialize()

コンポーネント生成時(Created->Alive)に呼び出されるアクションです。

戻り値:
実行結果

onFinalize

protected ReturnCode_t onFinalize()

コンポーネント破棄時(Alive->Exit)に呼び出されるアクションです。

戻り値:
実行結果

onStartup

protected ReturnCode_t onStartup(int ec_id)

ExecutionContextの動作開始時(Stopped->Started)に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onShutdown

protected ReturnCode_t onShutdown(int ec_id)

ExecutionContextの動作終了時(Started->Stopped)に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onActivated

protected ReturnCode_t onActivated(int ec_id)

RTコンポーネントのActivate時(Inactive->Active)に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onDeactivated

protected ReturnCode_t onDeactivated(int ec_id)

RTコンポーネントのDeactivate時(Active->Inactive)に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onExecute

protected ReturnCode_t onExecute(int ec_id)

RTコンポーネントがActivate状態の間呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onAborting

protected ReturnCode_t onAborting(int ec_id)

RTコンポーネントにエラーが発生した時(Active->Error)に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onError

protected ReturnCode_t onError(int ec_id)

RTコンポーネントがError状態の間呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onReset

protected ReturnCode_t onReset(int ec_id)

RTコンポーネントをresetする際(Error->Inactive)に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onStateUpdate

protected ReturnCode_t onStateUpdate(int ec_id)

RTコンポーネントがActivate状態の間、 on_executeの続いて呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

onRateChanged

protected ReturnCode_t onRateChanged(int ec_id)

ExecutionContextの実行周期が変更になった時に呼び出されるアクションです。

パラメータ:
ec_id - 対象ExecutionContext ID
戻り値:
実行結果

initialize

public ReturnCode_t initialize()

RTコンポーネントを初期化します。
このオペレーション呼び出しの結果として、ComponentAction::on_initialize コールバック関数が呼ばれます。
制約
Created状態にいるときにのみ、初期化が行われます。他の状態にいる場合には ReturnCode_t::PRECONDITION_NOT_MET が返され呼び出しは失敗します。 このオペレーションはRTCのミドルウエアから呼ばれることを想定しており、 アプリケーション開発者は直接このオペレーションを呼ぶことは想定 されていません。

戻り値:
実行結果

_finalize

public ReturnCode_t _finalize()
                       throws org.omg.CORBA.SystemException

RTコンポーネントを終了します。
このオペレーション呼び出しの結果として、ComponentAction::on_finalize コールバック関数が呼ばれます。
制約

  1. この RTC が属する Running 状態の実行コンテキスト中、Active 状態にある ものがあればこの RTC は終了されません。その場合、このオペレーション呼び 出しはいかなる場合も ReturnCode_t::PRECONDITION_NOT_ME で失敗します。
  2. この RTC が Created 状態である場合、終了処理は行われません。 その場合、このオペレーション呼び出しはいかなる場合も ReturnCode_t::PRECONDITION_NOT_MET で失敗します。
  3. アプリケーション開発者はこのオペレーションを直接的に呼び出すことは まれであり、たいていはRTCインフラストラクチャから呼び出されるます。

戻り値:
実行結果
例外:
org.omg.CORBA.SystemException

exit

public ReturnCode_t exit()
                  throws org.omg.CORBA.SystemException

RTコンポーネントを停止し、そのコンテンツとともに終了します。
この RTC がオーナーであるすべての実行コンテキストが停止されます。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければなりません。
制約

  1. RTC が初期化されていなければ、終了させることはできません。
  2. Created 状態にある RTC に exit() を呼び出した場合、 ReturnCode_t::PRECONDITION_NOT_MET で失敗します。

戻り値:
実行結果
例外:
org.omg.CORBA.SystemException

is_alive

public boolean is_alive(ExecutionContext exec_context)
                 throws org.omg.CORBA.SystemException

RTコンポーネントがAlive状態であるか判断します。
RTコンポーネントがAliveであるかどうかは、 ExecutionContextの状態(Inactive,Active,Error)とは独立しています。 1つのRTコンポーネントが、複数のExecutionContextにattachされる場合もあるため、 ExecutionContextの状態が混在する場合 (ExecutionContext1に対してはActive、ExecutionContext2に対してはInactiveなど) があるためです。

戻り値:
Alive状態判断結果
例外:
org.omg.CORBA.SystemException

get_owned_contexts

public ExecutionContext[] get_owned_contexts()
                                      throws org.omg.CORBA.SystemException

[CORBA interface] ExecutionContextListを取得します。

戻り値:
ExecutionContextリスト
例外:
org.omg.CORBA.SystemException

get_context

public ExecutionContext get_context(int ec_id)

[CORBA interface] ExecutionContextを取得します。

パラメータ:
ec_id - ExecutionContextのID
戻り値:
ExecutionContext

get_participating_contexts

public ExecutionContext[] get_participating_contexts()
                                              throws org.omg.CORBA.SystemException

[CORBA interface] LightweightRTObject

戻り値:
ExecutionContextList
例外:
org.omg.CORBA.SystemException

get_context_handle

public int get_context_handle(ExecutionContext cxt)
                       throws org.omg.CORBA.SystemException

[CORBA interface] LightweightRTObject

パラメータ:
cxt - ExecutionContext
戻り値:
ExecutionContextHandle_t
例外:
org.omg.CORBA.SystemException

bindContext

public int bindContext(ExecutionContext exec_context)

bindContext

パラメータ:
exec_context - ExecutionContext
戻り値:
int

get_component_profile

public ComponentProfile get_component_profile()
[RTObject CORBA interface] Get RTC's profile

This operation returns the ComponentProfile of the RTC.

戻り値:
ComponentProfile

get_ports

public PortService[] get_ports()

[RTObject CORBA interface] 当該コンポーネントが保有するポートの参照を取得します。

戻り値:
ポート参照情報

attach_context

public int attach_context(ExecutionContext exec_context)
                   throws org.omg.CORBA.SystemException

[CORBA interface] 当該コンポーネントをExecutionContextにattachします。

パラメータ:
exec_context - attach対象ExecutionContext
戻り値:
attachされたExecutionContext数
例外:
org.omg.CORBA.SystemException

detach_context

public ReturnCode_t detach_context(int ec_id)
                            throws org.omg.CORBA.SystemException

[CORBA interface] 当該コンポーネントをExecutionContextからdetachします。

パラメータ:
ec_id - detach対象ExecutionContextのID
戻り値:
実行結果
例外:
org.omg.CORBA.SystemException

on_initialize

public ReturnCode_t on_initialize()
[ComponentAction CORBA interface] Initialize RTC

The RTC has been initialized and entered the Alive state. Any RTC-specific initialization logic should be performed here. As a result of this operation, onInitialize() callback function is called.

戻り値:
The return code of ReturnCode_t type

on_finalize

public ReturnCode_t on_finalize()

[ComponentAction interface] 当該コンポーネントの終了時に呼び出されます。

戻り値:
実行結果

on_startup

public ReturnCode_t on_startup(int ec_id)

[ComponentAction interface] 当該コンポーネントのattachされているExecutionContextの実行開始時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_shutdown

public ReturnCode_t on_shutdown(int ec_id)

[ComponentAction interface] 当該コンポーネントのattachされているExecutionContextの実行終了時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_activated

public ReturnCode_t on_activated(int ec_id)

[ComponentAction interface] 当該コンポーネントのActivate時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_deactivated

public ReturnCode_t on_deactivated(int ec_id)

[ComponentAction interface] 当該コンポーネントのDeactivate時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_aborting

public ReturnCode_t on_aborting(int ec_id)

[ComponentAction interface] 当該コンポーネントのAbort時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_error

public ReturnCode_t on_error(int ec_id)

[ComponentAction interface] 当該コンポーネントがError状態にいる間、呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_reset

public ReturnCode_t on_reset(int ec_id)

[ComponentAction interface] 当該コンポーネントのReset時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_execute

public ReturnCode_t on_execute(int ec_id)
[DataFlowComponentAction CORBA interface] Primary Periodic Operation of RTC

The component is called during the state of Avtive.

パラメータ:
ec_id - ID of ExecutionContext
戻り値:
Execution result

on_state_update

public ReturnCode_t on_state_update(int ec_id)

[ComponentAction interface] 当該コンポーネントがAvtive状態の間、on_executeの後に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

on_rate_changed

public ReturnCode_t on_rate_changed(int ec_id)

[ComponentAction interface] 当該コンポーネントがattachされているExecutionContextの実行周期が変更になった時に呼び出されます。

パラメータ:
ec_id - 対象ExecutionContextのID
戻り値:
実行結果

get_owned_organizations

public Organization[] get_owned_organizations()
                                       throws NotAvailable

[CORBA interface] Organization リストを取得します。
SDOSystemElement は0個もしくはそれ以上の Organization を所有することが 出来ます。 SDOSystemElement が1つ以上の Organization を所有している場合 には、このオペレーションは所有する Organization のリストを返します。 もしOrganizationを一つも所有していないければ空のリストを返します。

戻り値:
Organization リスト
例外:
NotAvailable

get_sdo_id

public java.lang.String get_sdo_id()
                            throws NotAvailable,
                                   InternalError

[CORBA interface] SDO IDを取得します。
SDO ID を返すオペレーション。 このオペレーションは以下の型の例外を発生させる場合があります。

戻り値:
リソースデータモデルで定義されている SDO の ID
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_sdo_type

public java.lang.String get_sdo_type()
                              throws NotAvailable,
                                     InternalError

[CORBA interface] SDO タイプを取得します。
SDO Type を返すオペレーション。 このオペレーションは以下の型の例外を発生させる場合があります。

戻り値:
リソースデータモデルで定義されている SDO の Type
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_device_profile

public DeviceProfile get_device_profile()
                                 throws NotAvailable,
                                        InternalError

[CORBA interface] SDO DeviceProfile リストを取得します。
SDO の DeviceProfile を返すオペレーション。 SDO がハードウエアデバイスに関連付けられていない場合には、空の DeviceProfile を返します。 このオペレーションは以下の型の例外を発生させる場合があります。

戻り値:
リソースデータモデルで定義されている SDO の DeviceProfile
例外:
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_service_profiles

public ServiceProfile[] get_service_profiles()
                                      throws NotAvailable,
                                             InternalError

[CORBA interface] SDO ServiceProfile を取得します。
SDO が所有している Service の ServiceProfile を返すオペレーション。 SDO がサービスを一つも所有していない場合には、空のリストを返します。 このオペレーションは以下の型の例外を発生させる場合があります。

戻り値:
リソースデータモデルで定義されている SDO の ServiceProfile
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_service_profile

public ServiceProfile get_service_profile(java.lang.String id)
                                   throws InvalidParameter,
                                          NotAvailable,
                                          InternalError

[CORBA interface] 特定のServiceProfile を取得します。
引数 "id" で指定された名前のサービスの ServiceProfile を返します。

パラメータ:
id - SDO Service の ServiceProfile に関連付けられた識別子。
戻り値:
指定された SDO Service の ServiceProfile
例外:
InvalidParameter - パラメータ値が不正。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_sdo_service

public SDOService get_sdo_service(java.lang.String id)
                           throws InvalidParameter,
                                  NotAvailable,
                                  InternalError

[CORBA interface] 指定された SDO Service を取得します。
このオペレーションは引数 "id" で指定された名前によって区別される SDO の Service へのオブジェクト参照を返します。 SDO により提供される Service はそれぞれ一意の識別子により区別されます。

パラメータ:
id - SDO Service に関連付けられた識別子。
戻り値:
要求された SDO Service への参照。
例外:
InvalidParameter - パラメータ値が不正。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_configuration

public Configuration get_configuration()
                                throws InterfaceNotImplemented,
                                       NotAvailable,
                                       InternalError

[CORBA interface] Configuration オブジェクト を取得します。
このオペレーションは Configuration interface への参照を返します。 Configuration interface は各 SDO を管理するためのインターフェースのひとつです。 このインターフェースは DeviceProfile, ServiceProfile, Organization で定義された SDO の属性値を設定するために使用されます。 Configuration インターフェースの詳細については、OMG SDO specification の 2.3.5節, p.2-24 を参照してください。

戻り値:
SDO の Configuration インターフェースへの参照。
例外:
InterfaceNotImplemented - SDOはConfigurationインターフェースを持たない。
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_monitoring

public Monitoring get_monitoring()
                          throws InterfaceNotImplemented,
                                 NotAvailable,
                                 InternalError

[CORBA interface] Monitoring オブジェクト を取得します。
このオペレーションは Monitoring interface への参照を返します。 Monitoring interface は SDO が管理するインターフェースの一つです。 このインターフェースは SDO のプロパティをモニタリングするために使用されます。 Monitoring interface の詳細については OMG SDO specification の 2.3.7節 "Monitoring Interface" p.2-35 を参照してください。

戻り値:
SDO の Monitoring interfaceへの参照。
例外:
InterfaceNotImplemented - SDOはMonitoringインターフェースを持たない。
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_organizations

public Organization[] get_organizations()
                                 throws NotAvailable,
                                        InternalError

[CORBA interface] Organization リスト を取得します。
SDO は0個以上の Organization (組織)に所属することができます。 もし SDO が1個以上の Organization に所属している場合、このオペレーションは所属する Organization のリストを返します。SDO が どの Organization にも所属していない 場合には、空のリストが返されます。

戻り値:
SDO が所属する Organization のリスト。
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_status_list

public NameValue[] get_status_list()
                            throws NotAvailable,
                                   InternalError

[CORBA interface] SDO Status リスト を取得します。
このオペレーションは SDO のステータスを表す NVList を返します

戻り値:
SDO のステータス。
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InternalError - 内部的エラーが発生した。

get_status

public org.omg.CORBA.Any get_status(java.lang.String name)
                             throws InvalidParameter,
                                    NotAvailable,
                                    InternalError

[CORBA interface] SDO Status を取得します。
このオペレーションは 引数で指定された SDO のステータスを返します

パラメータ:
name - SDO のステータスを定義するパラメータ。
戻り値:
指定されたパラメータのステータス値。
例外:
SDONotExists - ターゲットのSDOが存在しない。
NotAvailable - SDOは存在するが応答がない。
InvalidParameter - 引数 "name" が null あるいは存在しない。
InternalError - 内部的エラーが発生した。

getInstanceName

public final java.lang.String getInstanceName()

当該オブジェクトのインスタンス名を取得します。

戻り値:
インスタンス名

setInstanceName

public void setInstanceName(java.lang.String instance_name)

当該オブジェクトのインスタンス名を設定します。

パラメータ:
instance_name - インスタンス名

getTypeName

public final java.lang.String getTypeName()

当該オブジェクトの型名を取得します。

戻り値:
型名

getCategory

public final java.lang.String getCategory()

当該オブジェクトのカテゴリを取得します。

戻り値:
カテゴリ

getNamingNames

public java.lang.String[] getNamingNames()

当該オブジェクトのNaming Seriveへの登録名を取得します。

戻り値:
Naming Seriveへの登録名

setObjRef

public void setObjRef(RTObject rtobj)

CORBAオブジェクト参照を設定します。

パラメータ:
rtobj - CORBAオブジェクト参照

getObjRef

public final RTObject getObjRef()

CORBAオブジェクト参照を取得します。

戻り値:
rtobj CORBAオブジェクト参照

setProperties

public void setProperties(Properties prop)

[local interface] RTC のプロパティを設定します。
RTコンポーネント が保持すべきプロパティを設定します。 与えられるプロパティは、ComponentProfile 等に設定されるべき情報を持たなければなりません。 このオペレーションは通常 RTコンポーネント が初期化される際に Manager から 呼ばれることを意図しています。

パラメータ:
prop - RTC のプロパティ

syncAttributesByProperties

protected void syncAttributesByProperties()
                                   throws java.lang.Exception

syncAttributesByProperties

例外:
java.lang.Exception

getProperties

public Properties getProperties()

[local interface] RTC のプロパティを取得します。
RTC が保持しているプロパティを返します。 RTCがプロパティを持たない場合は空のプロパティが返されます。

戻り値:
RTC のプロパティ

bindParameter

public boolean bindParameter(java.lang.String param_name,
                             ValueHolder var,
                             java.lang.String def_val)

コンフィギュレーション・パラメータをbindします。

パラメータ:
param_name - パラメータ名
var - 値保持用オブジェクト
def_val - デフォルト値
戻り値:
bind結果

updateParameters

public void updateParameters(java.lang.String config_set)

コンフィギュレーション・パラメータを更新します。

パラメータ:
config_set - 更新対象値

registerPort

public void registerPort(PortBase port)
[local interface] Register Port

This operation registers a Port held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

パラメータ:
port - Port which is registered to the RTC

addPort

public boolean addPort(PortBase port)
[local interface] Register Port

This operation registers a Port held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

パラメータ:
port - Port which is registered to the RTC
戻り値:
Register result (Successful:true, Failed:false)

registerPort

public void registerPort(PortService port)

[local interface] Register Port

This operation registers a Port held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

パラメータ:
port - Port which is registered to the RTC

addPort

public boolean addPort(PortService port)

[local interface] Register Port

This operation registers a Port held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

パラメータ:
port - Port which is registered to the RTC
戻り値:
Register result (Successful:true, Failed:false)

registerPort

public void registerPort(CorbaPort port)

[local interface] Register Port

This operation registers a Port held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

パラメータ:
port - Port which is registered to the RTC

addPort

public boolean addPort(CorbaPort port)

[local interface] Register Port

This operation registers a Port held by this RTC. In order to enable access to the Port from outside of RTC, the Port must be registered by this operation. The Port that is registered by this operation would be identified by PortProfile.name in the inside of RTC. Therefore, the Port should have unique PortProfile.name in the RTC. The registering Port would be activated properly, and the reference and the object reference would be stored in lists in RTC.

パラメータ:
port - Port which is registered to the RTC
戻り値:
Register result (Successful:true, Failed:false)

registerInPort

public <DataType,Buffer> void registerInPort(java.lang.Class<DataType> DATA_TYPE_CLASS,
                                             java.lang.String name,
                                             InPort<DataType> inport)
                    throws java.lang.Exception

[local interface] DataInPort を登録します。
RTC が保持するDataInPortを登録します。

パラメータ:
DATA_TYPE_CLASS - DataInPortがやりとりするデータ型
name - DataInPortの名称
inport - InPortへの参照
例外:
java.lang.Exception

addInPort

public boolean addInPort(java.lang.String name,
                         InPortBase inport)
[local interface] Register DataInPort.

This operation registers DataInPort held by this RTC. Set "port.dataport" and "tcp_any" to property of Port, and create instances of DataInPort and register it.

パラメータ:
name - Port name
inport - DataInPort which is registered to the RTC
戻り値:
Register result (Successful:true, Failed:false)

registerInPort

public void registerInPort(java.lang.String name,
                           InPortBase inport)
                    throws java.lang.Exception
[local interface] Register DataInPort.

This operation registers DataInPort held by this RTC. Set "port.dataport" and "tcp_any" to property of Port, and create instances of DataInPort and register it.

パラメータ:
name - name Port name
inport - DataInPort which is registered to the RTC
例外:
java.lang.Exception

addOutPort

public boolean addOutPort(java.lang.String name,
                          OutPortBase outport)
[local interface] Register DataOutPort.

This operation registers DataOutPor held by this RTC. Set "port.dataport" and "tcp_any" to property of Port, and then create instances of DataOutPort and register it.

パラメータ:
name - i Port name
outport - DataOutPort which is registered to the RTC
戻り値:
Register result (Successful:true, Failed:false)

registerOutPort

public <DataType,Buffer> void registerOutPort(java.lang.Class<DataType> DATA_TYPE_CLASS,
                                              java.lang.String name,
                                              OutPort<DataType> outport)
                     throws java.lang.Exception

[local interface] DataOutPort を登録します。
RTC が保持するDataOutPortを登録します。

パラメータ:
DATA_TYPE_CLASS - DataOutPortがやりとりするデータ型
name - DataOutPortの名称
outport - OutPortへの参照
例外:
java.lang.Exception

registerOutPort

public void registerOutPort(java.lang.String name,
                            OutPortBase outport)
                     throws java.lang.Exception
[local interface] Register DataOutPort

This operation registers DataOutPor held by this RTC. Set "port.dataport" and "tcp_any" to property of Port, and then create instances of DataOutPort and register it.

パラメータ:
name - Port name
outport - DataOutPort which is registered to the RTC
例外:
java.lang.Exception

removeInPort

public boolean removeInPort(InPortBase port)
[local interface] Unregister InPort

This operation unregisters a InPort held by this RTC.

パラメータ:
port - Port which is unregistered
戻り値:
Unregister result (Successful:true, Failed:false)

removeOutPort

public boolean removeOutPort(OutPortBase port)
[local interface] Unregister OutPort.

This operation unregisters a OutPort held by this RTC.

パラメータ:
port - Port which is unregistered
戻り値:
Unregister result (Successful:true, Failed:false)

removePort

public boolean removePort(PortBase port)
[local interface] Unregister Port

This operation unregisters a Port held by this RTC.

パラメータ:
port - Port which is unregistered
戻り値:
Unregister result (Successful:true, Failed:false)

removePort

public boolean removePort(PortService port)
[local interface] Unregister Port

This operation unregisters a Port held by this RTC.

パラメータ:
port - Port which is unregistered
戻り値:
Unregister result (Successful:true, Failed:false)

removePort

public boolean removePort(CorbaPort port)
[local interface] Unregister Port

This operation unregisters a Port held by this RTC.

パラメータ:
port - Port which is unregistered
戻り値:
Unregister result (Successful:true, Failed:false)

deletePort

public void deletePort(PortBase port)
[local interface] Unregister Port

This operation unregisters a Port held by this RTC.

パラメータ:
port - Port which is unregistered

deletePort

public void deletePort(PortService port)
[local interface] Unregister Port

This operation unregisters a Port held by this RTC.

パラメータ:
port - Port which is unregistered

deletePort

public void deletePort(CorbaPort port)
[local interface] Unregister Port

This operation unregisters a Port held by this RTC.

パラメータ:
port - Port which is unregistered

deletePortByName

public void deletePortByName(java.lang.String port_name)

[local interface] 名称によって指定された Port の登録を削除します。

パラメータ:
port_name - 削除対象のポート名

readAll

public boolean readAll()
Readout the value from All InPorts.

This operation read the value from all InPort registered in the RTC.

戻り値:
result (Successful:true, Failed:false)

writeAll

public boolean writeAll()
The write() method of all OutPorts are called.

This operation call the write() method of all OutPort registered in the RTC.

戻り値:
result (Successful:true, Failed:false)

setReadAll

public void setReadAll(boolean read,
                       boolean completion)
Set whether to execute the readAll() method.

Set whether to execute the readAll() method.

パラメータ:
read - (default:true) (readAll() is called:true, readAll() isn't called:false)
completion - (default:false) All InPort::read() calls are completed.:true, If one InPort::read() is False, return false.:false

setReadAll

public void setReadAll()

setReadAll

public void setReadAll(boolean read)

setWriteAll

public void setWriteAll(boolean write,
                        boolean completion)
@brief Set whether to execute the writeAll() method.

Set whether to execute the writeAll() method.

パラメータ:
write - (default:true) (writeAll() is called:true, writeAll() isn't called:false)
completion - (default:false) All OutPort::write() calls are completed.:true, If one OutPort::write() is False, return false.:false

setWriteAll

public void setWriteAll()

setWriteAll

public void setWriteAll(boolean write)

finalizePorts

public void finalizePorts()
Unregister All Ports

This operation deactivates the all Ports and deletes the all Port's registrations in the RTC


finalizeContexts

public void finalizeContexts()

登録されているすべてのContextの登録を削除します。


shutdown

protected void shutdown()

当該コンポーネントを終了します。