|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectorg.omg.PortableServer.Servant
OpenRTM.DataFlowComponentPOA
jp.go.aist.rtm.RTC.RTObject_impl
public class RTObject_impl
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. |
|
|
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. |
|
|
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 |
フィールドの詳細 |
---|
static final java.lang.String[] default_conf
RTコンポーネントのデフォルト・コンポーネント・プロファイルです。
public static final int ECOTHER_OFFSET
protected Manager m_pManager
Manager オブジェクト
protected org.omg.CORBA.ORB m_pORB
ORB
protected org.omg.PortableServer.POA m_pPOA
POA
protected OrganizationListHolder m_sdoOwnedOrganizations
SDO organization リスト
protected ServiceProfileListHolder m_sdoSvcProfiles
protected Configuration_impl m_pSdoConfigImpl
protected Configuration m_pSdoConfig
protected OrganizationListHolder m_sdoOrganizations
protected NVListHolder m_sdoStatus
protected ComponentProfile m_profile
protected RTObject m_objref
protected PortAdmin m_portAdmin
protected ExecutionContextServiceListHolder m_ecMine
protected java.util.Vector<ExecutionContextBase> m_eclist
protected ExecutionContextServiceListHolder m_ecOther
protected boolean m_created
protected Properties m_properties
protected ConfigAdmin m_configsets
protected Logbuf rtcout
Logging用フォーマットオブジェクト
protected java.util.Vector<InPortBase> m_inports
protected java.util.Vector<OutPortBase> m_outports
protected boolean m_readAll
protected boolean m_writeAll
protected boolean m_readAllCompletion
true:Even if the error occurs during readAll(), it executes it to the last minute. false:End when error occurs during readAll().
protected boolean m_writeAllCompletion
true:Even if the error occurs during writeAll(), it executes it to the last minute. false:End when error occurs during writeAll().
コンストラクタの詳細 |
---|
public RTObject_impl(Manager manager)
manager
-
Manager objectpublic RTObject_impl(org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa)
orb
-
ORBpoa
-
POAメソッドの詳細 |
---|
public DataFlowComponent _this()
_this
DataFlowComponentPOA
内の _this
protected ReturnCode_t onInitialize()
コンポーネント生成時(Created->Alive)に呼び出されるアクションです。
protected ReturnCode_t onFinalize()
コンポーネント破棄時(Alive->Exit)に呼び出されるアクションです。
protected ReturnCode_t onStartup(int ec_id)
ExecutionContextの動作開始時(Stopped->Started)に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onShutdown(int ec_id)
ExecutionContextの動作終了時(Started->Stopped)に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onActivated(int ec_id)
RTコンポーネントのActivate時(Inactive->Active)に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onDeactivated(int ec_id)
RTコンポーネントのDeactivate時(Active->Inactive)に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onExecute(int ec_id)
RTコンポーネントがActivate状態の間呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onAborting(int ec_id)
RTコンポーネントにエラーが発生した時(Active->Error)に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onError(int ec_id)
RTコンポーネントがError状態の間呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onReset(int ec_id)
RTコンポーネントをresetする際(Error->Inactive)に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onStateUpdate(int ec_id)
RTコンポーネントがActivate状態の間、 on_executeの続いて呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
protected ReturnCode_t onRateChanged(int ec_id)
ExecutionContextの実行周期が変更になった時に呼び出されるアクションです。
ec_id
- 対象ExecutionContext ID
public ReturnCode_t initialize()
RTコンポーネントを初期化します。
このオペレーション呼び出しの結果として、ComponentAction::on_initialize
コールバック関数が呼ばれます。
制約
Created状態にいるときにのみ、初期化が行われます。他の状態にいる場合には
ReturnCode_t::PRECONDITION_NOT_MET が返され呼び出しは失敗します。
このオペレーションはRTCのミドルウエアから呼ばれることを想定しており、
アプリケーション開発者は直接このオペレーションを呼ぶことは想定
されていません。
public ReturnCode_t _finalize() throws org.omg.CORBA.SystemException
RTコンポーネントを終了します。
このオペレーション呼び出しの結果として、ComponentAction::on_finalize
コールバック関数が呼ばれます。
制約
org.omg.CORBA.SystemException
public ReturnCode_t exit() throws org.omg.CORBA.SystemException
RTコンポーネントを停止し、そのコンテンツとともに終了します。
この RTC がオーナーであるすべての実行コンテキストが停止されます。
この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト
(i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの
オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上
で非活性化されなければなりません。
制約
org.omg.CORBA.SystemException
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など)
があるためです。
org.omg.CORBA.SystemException
public ExecutionContext[] get_owned_contexts() throws org.omg.CORBA.SystemException
[CORBA interface] ExecutionContextListを取得します。
org.omg.CORBA.SystemException
public ExecutionContext get_context(int ec_id)
[CORBA interface] ExecutionContextを取得します。
ec_id
- ExecutionContextのID
public ExecutionContext[] get_participating_contexts() throws org.omg.CORBA.SystemException
[CORBA interface] LightweightRTObject
org.omg.CORBA.SystemException
public int get_context_handle(ExecutionContext cxt) throws org.omg.CORBA.SystemException
[CORBA interface] LightweightRTObject
cxt
- ExecutionContext
org.omg.CORBA.SystemException
public int bindContext(ExecutionContext exec_context)
bindContext
exec_context
- ExecutionContext
public ComponentProfile get_component_profile()
This operation returns the ComponentProfile of the RTC.
public PortService[] get_ports()
[RTObject CORBA interface] 当該コンポーネントが保有するポートの参照を取得します。
public int attach_context(ExecutionContext exec_context) throws org.omg.CORBA.SystemException
[CORBA interface] 当該コンポーネントをExecutionContextにattachします。
exec_context
- attach対象ExecutionContext
org.omg.CORBA.SystemException
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
public ReturnCode_t on_initialize()
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.
public ReturnCode_t on_finalize()
[ComponentAction interface] 当該コンポーネントの終了時に呼び出されます。
public ReturnCode_t on_startup(int ec_id)
[ComponentAction interface] 当該コンポーネントのattachされているExecutionContextの実行開始時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_shutdown(int ec_id)
[ComponentAction interface] 当該コンポーネントのattachされているExecutionContextの実行終了時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_activated(int ec_id)
[ComponentAction interface] 当該コンポーネントのActivate時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_deactivated(int ec_id)
[ComponentAction interface] 当該コンポーネントのDeactivate時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_aborting(int ec_id)
[ComponentAction interface] 当該コンポーネントのAbort時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_error(int ec_id)
[ComponentAction interface] 当該コンポーネントがError状態にいる間、呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_reset(int ec_id)
[ComponentAction interface] 当該コンポーネントのReset時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_execute(int ec_id)
The component is called during the state of Avtive.
ec_id
-
ID of ExecutionContext
public ReturnCode_t on_state_update(int ec_id)
[ComponentAction interface] 当該コンポーネントがAvtive状態の間、on_executeの後に呼び出されます。
ec_id
- 対象ExecutionContextのID
public ReturnCode_t on_rate_changed(int ec_id)
[ComponentAction interface] 当該コンポーネントがattachされているExecutionContextの実行周期が変更になった時に呼び出されます。
ec_id
- 対象ExecutionContextのID
public Organization[] get_owned_organizations() throws NotAvailable
[CORBA interface] Organization リストを取得します。
SDOSystemElement は0個もしくはそれ以上の Organization を所有することが
出来ます。 SDOSystemElement が1つ以上の Organization を所有している場合
には、このオペレーションは所有する Organization のリストを返します。
もしOrganizationを一つも所有していないければ空のリストを返します。
NotAvailable
public java.lang.String get_sdo_id() throws NotAvailable, InternalError
[CORBA interface] SDO IDを取得します。
SDO ID を返すオペレーション。
このオペレーションは以下の型の例外を発生させる場合があります。
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。public java.lang.String get_sdo_type() throws NotAvailable, InternalError
[CORBA interface] SDO タイプを取得します。
SDO Type を返すオペレーション。
このオペレーションは以下の型の例外を発生させる場合があります。
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。public DeviceProfile get_device_profile() throws NotAvailable, InternalError
[CORBA interface] SDO DeviceProfile リストを取得します。
SDO の DeviceProfile を返すオペレーション。
SDO がハードウエアデバイスに関連付けられていない場合には、空の DeviceProfile を返します。
このオペレーションは以下の型の例外を発生させる場合があります。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。public ServiceProfile[] get_service_profiles() throws NotAvailable, InternalError
[CORBA interface] SDO ServiceProfile を取得します。
SDO が所有している Service の ServiceProfile を返すオペレーション。
SDO がサービスを一つも所有していない場合には、空のリストを返します。
このオペレーションは以下の型の例外を発生させる場合があります。
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。public ServiceProfile get_service_profile(java.lang.String id) throws InvalidParameter, NotAvailable, InternalError
[CORBA interface] 特定のServiceProfile を取得します。
引数 "id" で指定された名前のサービスの ServiceProfile を返します。
id
- SDO Service の ServiceProfile に関連付けられた識別子。
InvalidParameter
- パラメータ値が不正。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。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 に関連付けられた識別子。
InvalidParameter
- パラメータ値が不正。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。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 を参照してください。
InterfaceNotImplemented
- SDOはConfigurationインターフェースを持たない。
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。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 を参照してください。
InterfaceNotImplemented
- SDOはMonitoringインターフェースを持たない。
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。public Organization[] get_organizations() throws NotAvailable, InternalError
[CORBA interface] Organization リスト を取得します。
SDO は0個以上の Organization (組織)に所属することができます。
もし SDO が1個以上の Organization に所属している場合、このオペレーションは所属する
Organization のリストを返します。SDO が どの Organization にも所属していない
場合には、空のリストが返されます。
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。public NameValue[] get_status_list() throws NotAvailable, InternalError
[CORBA interface] SDO Status リスト を取得します。
このオペレーションは SDO のステータスを表す NVList を返します
SDONotExists
- ターゲットのSDOが存在しない。
NotAvailable
- SDOは存在するが応答がない。
InternalError
- 内部的エラーが発生した。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
- 内部的エラーが発生した。public final java.lang.String getInstanceName()
当該オブジェクトのインスタンス名を取得します。
public void setInstanceName(java.lang.String instance_name)
当該オブジェクトのインスタンス名を設定します。
instance_name
- インスタンス名public final java.lang.String getTypeName()
当該オブジェクトの型名を取得します。
public final java.lang.String getCategory()
当該オブジェクトのカテゴリを取得します。
public java.lang.String[] getNamingNames()
当該オブジェクトのNaming Seriveへの登録名を取得します。
public void setObjRef(RTObject rtobj)
CORBAオブジェクト参照を設定します。
rtobj
- CORBAオブジェクト参照public final RTObject getObjRef()
CORBAオブジェクト参照を取得します。
public void setProperties(Properties prop)
[local interface] RTC のプロパティを設定します。
RTコンポーネント が保持すべきプロパティを設定します。
与えられるプロパティは、ComponentProfile 等に設定されるべき情報を持たなければなりません。
このオペレーションは通常 RTコンポーネント が初期化される際に Manager から
呼ばれることを意図しています。
prop
- RTC のプロパティprotected void syncAttributesByProperties() throws java.lang.Exception
syncAttributesByProperties
java.lang.Exception
public Properties getProperties()
[local interface] RTC のプロパティを取得します。
RTC が保持しているプロパティを返します。
RTCがプロパティを持たない場合は空のプロパティが返されます。
public boolean bindParameter(java.lang.String param_name, ValueHolder var, java.lang.String def_val)
コンフィギュレーション・パラメータをbindします。
param_name
- パラメータ名var
- 値保持用オブジェクトdef_val
- デフォルト値
public void updateParameters(java.lang.String config_set)
コンフィギュレーション・パラメータを更新します。
config_set
- 更新対象値public void registerPort(PortBase 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 RTCpublic boolean addPort(PortBase 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
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 RTCpublic 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
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 RTCpublic 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
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
public boolean addInPort(java.lang.String name, InPortBase inport)
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 nameinport
-
DataInPort which is registered to the RTC
public void registerInPort(java.lang.String name, InPortBase inport) throws java.lang.Exception
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 nameinport
-
DataInPort which is registered to the RTC
java.lang.Exception
public boolean addOutPort(java.lang.String name, OutPortBase outport)
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 nameoutport
-
DataOutPort which is registered to the RTC
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
public void registerOutPort(java.lang.String name, OutPortBase outport) throws java.lang.Exception
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 nameoutport
-
DataOutPort which is registered to the RTC
java.lang.Exception
public boolean removeInPort(InPortBase port)
This operation unregisters a InPort held by this RTC.
port
-
Port which is unregistered
public boolean removeOutPort(OutPortBase port)
This operation unregisters a OutPort held by this RTC.
port
-
Port which is unregistered
public boolean removePort(PortBase port)
This operation unregisters a Port held by this RTC.
port
-
Port which is unregistered
public boolean removePort(PortService port)
This operation unregisters a Port held by this RTC.
port
-
Port which is unregistered
public boolean removePort(CorbaPort port)
This operation unregisters a Port held by this RTC.
port
-
Port which is unregistered
public void deletePort(PortBase port)
This operation unregisters a Port held by this RTC.
port
-
Port which is unregisteredpublic void deletePort(PortService port)
This operation unregisters a Port held by this RTC.
port
-
Port which is unregisteredpublic void deletePort(CorbaPort port)
This operation unregisters a Port held by this RTC.
port
-
Port which is unregisteredpublic void deletePortByName(java.lang.String port_name)
[local interface] 名称によって指定された Port の登録を削除します。
port_name
- 削除対象のポート名public boolean readAll()
This operation read the value from all InPort registered in the RTC.
public boolean writeAll()
This operation call the write() method of all OutPort registered in the RTC.
public void setReadAll(boolean read, boolean completion)
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.:falsepublic void setReadAll()
public void setReadAll(boolean read)
public void setWriteAll(boolean write, boolean completion)
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.:falsepublic void setWriteAll()
public void setWriteAll(boolean write)
public void finalizePorts()
This operation deactivates the all Ports and deletes the all Port's registrations in the RTC
public void finalizeContexts()
登録されているすべてのContextの登録を削除します。
protected void shutdown()
当該コンポーネントを終了します。
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |