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

RTコンポーネントクラス。

DataFlowComponentのベースクラス。 ユーザが新たなRTコンポーネントを作成する場合は、このクラスを拡張する。 各RTコンポーネントのベースとなるクラス。 Robotic Technology Component 仕様中の lightweightRTComponentの実装クラス。 コンポーネントの機能を提供する ComponentAction インターフェースと コンポーネントのライフサイクル管理を行うための LightweightRTObject の実装を 提供する。 実際にユーザがコンポーネントを作成する場合には、Execution Semantics に対応 した各サブクラスを利用する。
(現状の実装では Periodic Sampled Data Processing のみサポートしているため、 dataFlowComponent を直接継承している)

入れ子のクラスの概要

(package private) class	RTObject_impl.deactivate_comps 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 ComponentActionListeners	m_actionListeners ComponentActionListenerホルダ ComponentActionListenrを保持するホルダ
protected ConfigAdmin	m_configsets コンフィギュレーション情報管理オブジェクト
protected boolean	m_created Created 状態フラグ
protected java.util.Vector<ExecutionContextBase>	m_eclist ExecutionContextBase のリスト
protected ExecutionContextServiceListHolder	m_ecMine 自分がownerのExecutionContextService のリスト
protected ExecutionContextServiceListHolder	m_ecOther 参加しているExecutionContextService のリスト
protected java.util.Vector<InPortBase>	m_inports InPortBase のリスト.
protected RTObject	m_objref オブジェクトリファレンス
protected java.util.Vector<OutPortBase>	m_outports OutPortBase のリスト.
protected Manager	m_pManager マネージャオブジェクト
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 コンポーネントプロファイル
protected Properties	m_properties RTC のプロパティ
protected Configuration	m_pSdoConfig SDO Configuration Interface
protected Configuration_impl	m_pSdoConfigImpl SDO Configuration オブジェクト
protected boolean	m_readAll readAll()呼出用のフラグ
protected boolean	m_readAllCompletion readAll()用のフラグ true: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 writeAll()呼出用のフラグ
protected boolean	m_writeAllCompletion writeAll()用のフラグ
protected Logbuf	rtcout ロガーストリーム

コンストラクタの概要

RTObject_impl(Manager manager)
コンストラクタ。

RTObject_impl(org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa)
コンストラクタ。

メソッドの概要

ReturnCode_t	_finalize() [CORBA interface] RTC を終了する。
DataFlowComponent	_this() DataFlowComponentオブジェクトの取得。
void	addExecutionContextActionListener(int listener_type, ExecutionContextActionListener listener)
void	addExecutionContextActionListener(int listener_type, ExecutionContextActionListener listener, boolean autoclean) ExecutionContextActionListener リスナを追加する {@.ja ExecutionContextの追加、削除時にコールバックされる各種リスナを設定する。
boolean	addInPort(java.lang.String name, InPortBase inport) [local interface] DataInPort を登録する.
boolean	addOutPort(java.lang.String name, OutPortBase outport) [local interface] DataOutPort を登録する.
boolean	addPort(CorbaPort port) [local interface] Port を登録する。
boolean	addPort(PortBase port) [local interface] Port を登録する。
boolean	addPort(PortService port) [local interface] Port を登録する。
void	addPortActionListener(int listener_type, PortActionListener listener)
void	addPortActionListener(int listener_type, PortActionListener listener, boolean autoclean) PortActionListener リスナを追加する {@.ja Portの追加、削除時にコールバックされる各種リスナを設定する。
void	addPostComponentActionListener(int listener_type, PostComponentActionListener listener)
void	addPostComponentActionListener(int listener_type, PostComponentActionListener listener, boolean autoclean) PostComponentActionListener リスナを追加する {@.ja ComponentAction 実装関数の呼び出し直後のイベントに関連する各種リ スナを設定する。
void	addPreComponentActionListener(int listener_type, PreComponentActionListener listener)
void	addPreComponentActionListener(int listener_type, PreComponentActionListener listener, boolean autoclean) PreComponentActionListener リスナを追加する {@.ja ComponentAction 実装関数の呼び出し直前のイベントに関連する各種リ スナを設定する。
int	attach_context(ExecutionContext exec_context) [CORBA interface] ExecutionContextをattachする。
int	bindContext(ExecutionContext exec_context) ECをバインドする。
boolean	bindParameter(java.lang.String param_name, ValueHolder var, java.lang.String def_val) コンフィギュレーションパラメータの設定。
void	deletePort(CorbaPort port) [local interface] Port の登録を削除します。
void	deletePort(PortBase port) [local interface] Port の登録を削除します。
void	deletePort(PortService port) [local interface] 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() [CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる
void	finalizeContexts() ExecutionContextBaseリストの登録を削除する
void	finalizePorts() 登録されているすべてのPortの登録を削除します。
ComponentProfile	get_component_profile() [RTObject CORBA interface] コンポーネントプロファイルを取得する。
Configuration	get_configuration() [SDO interface] Configuration オブジェクトの取得。
int	get_context_handle(ExecutionContext cxt) [CORBA interface] ExecutionContext のハンドルを返す。
ExecutionContext	get_context(int ec_id) [CORBA interface] ExecutionContextを取得する。
DeviceProfile	get_device_profile() [SDO interface] SDO DeviceProfile リストの取得。
Monitoring	get_monitoring() [SDO interface] Monitoring オブジェクトの取得。
Organization[]	get_organizations() [SDO interface] Organization リストの取得。
ExecutionContext[]	get_owned_contexts() [CORBA interface] 所有する ExecutionContextListを 取得する。
Organization[]	get_owned_organizations() [SDO interface] Organization リストの取得。
ExecutionContext[]	get_participating_contexts() [CORBA interface] 参加している ExecutionContextList を取得する。
PortService[]	get_ports() [RTObject CORBA interface] ポートを取得する。
java.lang.String	get_sdo_id() [SDO interface] SDO ID の取得。
SDOService	get_sdo_service(java.lang.String id) [SDO interface] 指定された SDO Service の取得。
java.lang.String	get_sdo_type() [SDO interface] SDO タイプの取得。
ServiceProfile	get_service_profile(java.lang.String id) [SDO interface] 特定のServiceProfileの取得。
ServiceProfile[]	get_service_profiles() [SDO interface] SDO ServiceProfile の取得。
NameValue[]	get_status_list() [SDO interface] SDO Status リストの取得。
org.omg.CORBA.Any	get_status(java.lang.String name) [SDO interface] SDO Status の取得。
java.lang.String	getCategory() [local interface] カテゴリ情報の取得。
java.lang.String	getInstanceName() [local interface] インスタンス名の取得。
java.lang.String[]	getNamingNames() [local interface] Naming Server 情報の取得。
RTObject	getObjRef() [local interface] オブジェクトリファレンスの取得。
Properties	getProperties() [local interface] RTC のプロパティを取得する。
java.lang.String	getTypeName() [local interface] 型名の取得。
ReturnCode_t	initialize() [CORBA interface] RTCを初期化する
boolean	is_alive(ExecutionContext exec_context) [CORBA interface] RTC が Alive 状態であるかどうか確認する。
ReturnCode_t	on_aborting(int ec_id) [ComponentAction CORBA interface] RTC のエラー状態への遷移。
ReturnCode_t	on_activated(int ec_id) [ComponentAction CORBA interface] 当該コンポーネントの Activate時に呼び出される。
ReturnCode_t	on_deactivated(int ec_id) [ComponentAction CORBA interface] 当該コンポーネントの Deactivate時に呼び出される。
ReturnCode_t	on_error(int ec_id) [ComponentAction CORBA interface] RTC のエラー処理 {@.ja RTC がエラー状態にいる際に呼び出される。
ReturnCode_t	on_execute(int ec_id) [DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期) 当該コンポーネントがAvtive状態の間、呼び出されます。
ReturnCode_t	on_finalize() [ComponentAction CORBA interface] 当該コンポーネントの終了時に 呼び出される。
ReturnCode_t	on_initialize() [ComponentAction CORBA interface] RTC の初期化。
ReturnCode_t	on_rate_changed(int ec_id) [DataFlowComponentAction CORBA interface] 実行周期変更通知。
ReturnCode_t	on_reset(int ec_id) [ComponentAction CORBA interface] RTC のリセット。
ReturnCode_t	on_shutdown(int ec_id) [ComponentAction CORBA interface] 当該コンポーネントのattachされ ているExecutionContextの実行終了時に呼び出される。
ReturnCode_t	on_startup(int ec_id) [ComponentAction CORBA interface] 当該コンポーネントの attachされているExecutionContextの実行開始時に呼び出される。
ReturnCode_t	on_state_update(int ec_id) [DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)。
protected ReturnCode_t	onAborting(int ec_id) 中断処理用コールバック関数。
protected ReturnCode_t	onActivated(int ec_id) 活性化処理用コールバック関数。
protected void	onAddPort(PortProfile pprof)
protected void	onAttachExecutionContext(int ec_id)
protected ReturnCode_t	onDeactivated(int ec_id) 非活性化処理用コールバック関数。
protected void	onDetachExecutionContext(int ec_id)
protected ReturnCode_t	onError(int ec_id) エラー処理用コールバック関数。
protected ReturnCode_t	onExecute(int ec_id) 周期処理用コールバック関数。
protected ReturnCode_t	onFinalize() 終了処理用コールバック関数。
protected ReturnCode_t	onInitialize() 初期化処理用コールバック関数。
protected ReturnCode_t	onRateChanged(int ec_id) 動作周期変更通知用コールバック関数。
protected void	onRemovePort(PortProfile pprof)
protected ReturnCode_t	onReset(int ec_id) リセット処理用コールバック関数。
protected ReturnCode_t	onShutdown(int ec_id) 停止処理用コールバック関数。
protected ReturnCode_t	onStartup(int ec_id) 開始処理用コールバック関数。
protected ReturnCode_t	onStateUpdate(int ec_id) 状態変更処理用コールバック関数。
protected void	postOnAborting(int ec_id, ReturnCode_t ret)
protected void	postOnActivated(int ec_id, ReturnCode_t ret)
protected void	postOnDeactivated(int ec_id, ReturnCode_t ret)
protected void	postOnError(int ec_id, ReturnCode_t ret)
protected void	postOnExecute(int ec_id, ReturnCode_t ret)
protected void	postOnFinalize(int ec_id, ReturnCode_t ret)
protected void	postOnInitialize(int ec_id, ReturnCode_t ret)
protected void	postOnRateChanged(int ec_id, ReturnCode_t ret)
protected void	postOnReset(int ec_id, ReturnCode_t ret)
protected void	postOnShutdown(int ec_id, ReturnCode_t ret)
protected void	postOnStartup(int ec_id, ReturnCode_t ret)
protected void	postOnStateUpdate(int ec_id, ReturnCode_t ret)
protected void	preOnAborting(int ec_id)
protected void	preOnActivated(int ec_id)
protected void	preOnDeactivated(int ec_id)
protected void	preOnError(int ec_id)
protected void	preOnExecute(int ec_id)
protected void	preOnFinalize(int ec_id)
protected void	preOnInitialize(int ec_id)
protected void	preOnRateChanged(int ec_id)
protected void	preOnReset(int ec_id)
protected void	preOnShutdown(int ec_id)
protected void	preOnStartup(int ec_id)
protected void	preOnStateUpdate(int ec_id)
boolean	readAll() 全 InPort のデータを読み込む。
<DataType,Buffer> void	registerInPort(java.lang.Class<DataType> DATA_TYPE_CLASS, java.lang.String name, InPort<DataType> inport) [local interface] DataInPort を登録する.
void	registerInPort(java.lang.String name, InPortBase inport) [local interface] 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] DataOutPort を登録します。
void	registerPort(CorbaPort port) [local interface] Port を登録する。
void	registerPort(PortBase port) [local interface] Port を登録する。
void	registerPort(PortService port) [local interface] Port を登録する。
void	removeExecutionContextActionListener(int listener_type, ExecutionContextActionListener listener) ExecutionContextActionListener リスナを削除する 設定した各種リスナを削除する。
boolean	removeInPort(InPortBase port) [local interface] InPort の登録を削除する RTC が保持するInPortの登録を削除する。
boolean	removeOutPort(OutPortBase port) [local interface] OutPort の登録を削除する
boolean	removePort(CorbaPort port) [local interface] Port の登録を削除する RTC が保持するPortの登録を削除する。
boolean	removePort(PortBase port) [local interface] Port の登録を削除する RTC が保持するPortの登録を削除する。
boolean	removePort(PortService port) [local interface] Port の登録を削除する RTC が保持するPortの登録を削除する。
void	removePortActionListener(int listener_type, PortActionListener listener) PortActionListener リスナを削除する 設定した各種リスナを削除する。
void	removePostComponentActionListener(int listener_type, PostComponentActionListener listener) PostComponentActionListener リスナを削除する 設定した各種リスナを削除する。
void	removePreComponentActionListener(int listener_type, PreComponentActionListener listener) PreComponentActionListener リスナを削除する 設定した各種リスナを削除する。
void	setInstanceName(java.lang.String instance_name) [local interface] インスタンス名の設定。
void	setObjRef(RTObject rtobj) [local interface] オブジェクトリファレンスの設定。
void	setProperties(Properties prop) [local interface] RTC のプロパティを設定する。
void	setReadAll() onExecute()実行前でのreadAll()メソッドの呼出を有効または 無効にする。
void	setReadAll(boolean read) onExecute()実行前でのreadAll()メソッドの呼出を有効または 無効にする。
void	setReadAll(boolean read, boolean completion) onExecute()実行前でのreadAll()メソッドの呼出を有効または 無効にする。
void	setWriteAll() onExecute()実行後にwriteAll()メソッドの呼出を有効または 無効にする。
void	setWriteAll(boolean write) onExecute()実行後にwriteAll()メソッドの呼出を有効または 無効にする。
void	setWriteAll(boolean write, boolean completion) onExecute()実行後にwriteAll()メソッドの呼出を有効または 無効にする。
protected void	shutdown() RTC を終了する。
protected void	syncAttributesByProperties() プロパティを設定する
void	updateParameters(java.lang.String config_set) コンフィギュレーションパラメータの更新。
boolean	writeAll() 全 OutPort のwrite()メソッドをコールする。

クラス 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

マネージャオブジェクト

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 オブジェクト

m_pSdoConfig

protected Configuration m_pSdoConfig

SDO Configuration Interface

m_sdoOrganizations

protected OrganizationListHolder m_sdoOrganizations

SDO organization

m_sdoStatus

protected NVListHolder m_sdoStatus

SDO Status

m_profile

protected ComponentProfile m_profile

コンポーネントプロファイル

m_objref

protected RTObject m_objref

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

m_portAdmin

protected PortAdmin m_portAdmin

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

m_ecMine

protected ExecutionContextServiceListHolder m_ecMine

自分がownerのExecutionContextService のリスト

m_eclist

protected java.util.Vector<ExecutionContextBase> m_eclist

ExecutionContextBase のリスト

m_ecOther

protected ExecutionContextServiceListHolder m_ecOther

参加しているExecutionContextService のリスト

m_created

protected boolean m_created

Created 状態フラグ

m_properties

protected Properties m_properties

RTC のプロパティ

m_configsets

protected ConfigAdmin m_configsets

コンフィギュレーション情報管理オブジェクト

rtcout

protected Logbuf rtcout

ロガーストリーム

m_inports

protected java.util.Vector<InPortBase> m_inports

InPortBase のリスト.

m_outports

protected java.util.Vector<OutPortBase> m_outports

OutPortBase のリスト.

m_readAll

protected boolean m_readAll

readAll()呼出用のフラグ

m_writeAll

protected boolean m_writeAll

writeAll()呼出用のフラグ

m_readAllCompletion

protected boolean m_readAllCompletion

readAll()用のフラグ

true:readAll()の途中ででエラーが発生しても最後まで実施する。 false:readAll()の途中ででエラーが発生した場合終了。

m_writeAllCompletion

protected boolean m_writeAllCompletion

writeAll()用のフラグ

true:writeAll()の途中ででエラーが発生しても最後まで実施する。 false:writeAll()の途中ででエラーが発生した場合終了。

m_actionListeners

protected ComponentActionListeners m_actionListeners

ComponentActionListenerホルダ

ComponentActionListenrを保持するホルダ

コンストラクタの詳細

RTObject_impl

public RTObject_impl(Manager manager)

コンストラクタ。

パラメータ:

manager - Managerオブジェクト

RTObject_impl

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

コンストラクタ。

パラメータ:

orb - ORB

poa - POA

メソッドの詳細

_this

public DataFlowComponent _this()

DataFlowComponentオブジェクトの取得。

DataFlowComponentオブジェクト参照を取得する。

オーバーライド:

クラス DataFlowComponentPOA 内の _this

戻り値:

DataFlowComponentオブジェクト

onInitialize

protected ReturnCode_t onInitialize()

初期化処理用コールバック関数。

コンポーネント生成時(Created->Alive)に呼び出されるアクション。 ComponentAction.on_initialize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に ReturnCode_t.RTC_OK を返すようにダミー実装されている ので、 各コンポーネントの実際の初期化処理は、本関数をオーバーライドして実装する 必要がある。

戻り値:

ReturnCode_t 型のリターンコード

onFinalize

protected ReturnCode_t onFinalize()

終了処理用コールバック関数。

コンポーネント破棄時(Alive->Exit)に呼び出されるアクション。 ComponentAction.on_finalize が呼ばれた際に実行されるコールバック関数。 本関数は無条件に ReturnCode_t.RTC_OK を返すようにダミー実装されている ので、 各コンポーネントの実際の終了処理は、本関数をオーバーライドして実装する 必要がある。

戻り値:

ReturnCode_t 型のリターンコード

onStartup

protected ReturnCode_t onStartup(int ec_id)

開始処理用コールバック関数。

ExecutionContextの動作開始時(Stopped->Started)に呼び出される アクション。 ComponentAction.on_startup が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に ReturnCode_t.RTC_OK を返すようにダミー実装されている ので、 各コンポーネントの実際の開始処理は、本関数をオーバーライドして実装する 必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onShutdown

protected ReturnCode_t onShutdown(int ec_id)

停止処理用コールバック関数。

ExecutionContextの動作終了時(Started->Stopped)に呼び出される アクション。 ComponentAction::on_shutdown が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の停止処理は、本関数をオーバーライドして実装する 必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onActivated

protected ReturnCode_t onActivated(int ec_id)

活性化処理用コールバック関数。

RTコンポーネントのActivate時(Inactive->Active)に呼び出される アクション。 ComponentAction.on_activated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の活性化処理は、本関数をオーバーライドして実装する 必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onDeactivated

protected ReturnCode_t onDeactivated(int ec_id)

非活性化処理用コールバック関数。

RTコンポーネントのDeactivate時(Active->Inactive)に呼び出される アクション。 ComponentAction.on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に ReturnCode_t.RTC_OK を返すようにダミー実装されている ので、 各コンポーネントの実際の非活性化処理は、本関数をオーバーライドして 実装する必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onExecute

protected ReturnCode_t onExecute(int ec_id)

周期処理用コールバック関数。 [@.en Callback function to execute periodically}

RTコンポーネントがActivate状態の間呼び出されるアクション。 DataFlowComponentAction::on_execute が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の周期処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの １回目の実行パスとして定期的に呼び出される。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onAborting

protected ReturnCode_t onAborting(int ec_id)

中断処理用コールバック関数。

RTコンポーネントにエラーが発生した時(Active->Error)に呼び出される アクション。 ComponentAction::on_aborting が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の中断処理は、本関数をオーバーライドして実装する 必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onError

protected ReturnCode_t onError(int ec_id)

エラー処理用コールバック関数。

RTコンポーネントがError状態の間呼び出されるアクション。 ComponentAction::on_error が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のエラー処理は、本関数をオーバーライドして実装する 必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onReset

protected ReturnCode_t onReset(int ec_id)

リセット処理用コールバック関数。

RTコンポーネントをresetする際(Error->Inactive)に呼び出される アクション。 ComponentAction.on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に ReturnCode_t.RTC_OK を返すようにダミー実装されている ので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドして実装 する必要がある。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onStateUpdate

protected ReturnCode_t onStateUpdate(int ec_id)

状態変更処理用コールバック関数。

RTコンポーネントがActivate状態の間、 on_executeの続いて呼び出されるアクション。 DataFlowComponentAction::on_state_update が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして 実装する必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの ２回目の実行パスとして定期的に呼び出される。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

onRateChanged

protected ReturnCode_t onRateChanged(int ec_id)

動作周期変更通知用コールバック関数。

ExecutionContextの実行周期が変更になった時に呼び出される アクション。 DataFlowComponentAction::on_rate_changed が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして 実装する必要がある。
本関数は Periodic Sampled Data Processing において ExecutionContext の 実行が更新された際に呼び出される。

パラメータ:

ec_id - 対象ExecutionContext ID

戻り値:

ReturnCode_t 型のリターンコード

initialize

public ReturnCode_t initialize()

[CORBA interface] RTCを初期化する

このオペレーション呼び出しの結果として、 ComponentAction::on_initialize コールバック関数が呼ばれる。 制約

• RTC は Created状態の場合み初期化が行われる。他の状態にいる場合には ReturnCode_t::PRECONDITION_NOT_MET が返され呼び出しは失敗する。
• このオペレーションは RTC のミドルウエアから呼ばれることを 想定しており、アプリケーション開発者は直接このオペレーションを 呼ぶことは想定されていない。

戻り値:

ReturnCode_t 型のリターンコード

_finalize

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

[CORBA interface] RTC を終了する。

このオペレーション呼び出しの結果として ComponentAction.on_finalize() を呼び出す。 制約

• RTC が ExecutionContext に所属している間は終了されない。この場合は、 まず最初に ExecutionContextOperations::remove によって参加を 解除しなければならない。これ以外の場合は、このオペレーション呼び出しは いかなる場合も ReturnCode_t::PRECONDITION_NOT_ME で失敗する。
• RTC が Created 状態である場合、終了処理は行われない。 この場合、このオペレーション呼び出しはいかなる場合も ReturnCode_t::PRECONDITION_NOT_MET で失敗する。
• このオペレーションはRTCのミドルウエアから呼ばれることを 想定しており、 アプリケーション開発者は直接このオペレーションを呼ぶことは想定 されていない。

戻り値:

ReturnCode_t 型のリターンコード

例外:

org.omg.CORBA.SystemException

exit

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

[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる

この RTC がオーナーであるすべての実行コンテキストを停止する。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければならない。 RTC が実行中のどの ExecutionContext でも Active 状態ではなくなった後、 この RTC とこれに含まれる RTC が終了する。 制約

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

戻り値:

ReturnCode_t 型のリターンコード

例外:

org.omg.CORBA.SystemException

is_alive

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

[CORBA interface] RTC が Alive 状態であるかどうか確認する。

RTC が指定した ExecutionContext に対して Alive状態であるかどうかi 確認する。 RTC の状態が Active であるか、Inactive であるか、Error であるかは実行中の ExecutionContext に依存する。すなわち、ある ExecutionContext に対しては Active 状態であっても、他の ExecutionContext に対しては Inactive 状態と なる場合もありえる。従って、このオペレーションは指定された ExecutionContext に問い合わせて、この RTC の状態が Active、Inactive、 Error の場合には Alive 状態として返す。 RTコンポーネントがAliveであるかどうかは、 ExecutionContextの状態(Inactive，Active，Error)とは独立している。 １つの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を 取得する。

この RTC が所有する ExecutionContext のリストを取得する。

戻り値:

ExecutionContext リスト

例外:

org.omg.CORBA.SystemException

get_context

public ExecutionContext get_context(int ec_id)

[CORBA interface] ExecutionContextを取得する。

指定したハンドルの ExecutionContext を取得する。 ハンドルから ExecutionContext へのマッピングは、特定の RTC インスタンスに 固有である。ハンドルはこの RTC を attach_context した際に取得できる。

パラメータ:

ec_id - ExecutionContextのID

戻り値:

ExecutionContext

get_participating_contexts

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

[CORBA interface] 参加している ExecutionContextList を取得する。

この RTC が参加している ExecutionContext のリストを取得する。

戻り値:

ExecutionContext リスト

例外:

org.omg.CORBA.SystemException

get_context_handle

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

[CORBA interface] ExecutionContext のハンドルを返す。

与えられた実行コンテキストに関連付けられたハンドルを返す。

パラメータ:

cxt - ExecutionContext

戻り値:

ExecutionContextHandle_t

例外:

org.omg.CORBA.SystemException

bindContext

public int bindContext(ExecutionContext exec_context)

ECをバインドする。

パラメータ:

exec_context - ExecutionContext

戻り値:

ID(失敗した場合は-1を返す。)

get_component_profile

public ComponentProfile get_component_profile()

[RTObject CORBA interface] コンポーネントプロファイルを取得する。

当該コンポーネントのプロファイル情報を返す。

戻り値:

コンポーネントプロファイル

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する。

指定した ExecutionContext にこの RTC を所属させる。 この RTC と関連する ExecutionContext のハンドルを返す。 このオペレーションは、ExecutionContextOperations.add_component が 呼ばれた際に呼び出される。 返されたハンドルは他のクライアントで使用することを想定していない。

パラメータ:

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する。

指定した ExecutionContext からこの RTC の所属を解除する。 このオペレーションは、ExecutionContextOperations::remove が呼ば れた際に呼び出される。返されたハンドルは他のクライアントで使用することを 想定していない。 制約

• 指定された ExecutionContext に RTC がすでに所属していない場合には、 ReturnCode_t.PRECONDITION_NOT_MET が返される。
• 指定された ExecutionContext にたしいて対して RTC が Active 状態である場合には、 ReturnCode_t.PRECONDITION_NOT_MET が返される。

パラメータ:

ec_id - detach対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

例外:

org.omg.CORBA.SystemException

on_initialize

public ReturnCode_t on_initialize()

[ComponentAction CORBA interface] RTC の初期化。

RTC が初期化され、Alive 状態に遷移する。 RTC 固有の初期化処理はここで実行する。 このオペレーション呼び出しの結果として onInitialize() コールバック関数が 呼び出される。

戻り値:

ReturnCode_t 型のリターンコード

on_finalize

public ReturnCode_t on_finalize()

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

RTC が破棄される。 RTC 固有の終了処理はここで実行する。 このオペレーション呼び出しの結果として onFinalize() コールバック関数が 呼び出される。

戻り値:

ReturnCode_t 型のリターンコード

on_startup

public ReturnCode_t on_startup(int ec_id)

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

RTC が所属する ExecutionContext が Stopped 状態から Running 状態へ遷移した場合に呼び出される。 このオペレーション呼び出しの結果として onStartup() コールバック関数が 呼び出される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_shutdown

public ReturnCode_t on_shutdown(int ec_id)

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

RTC が所属する ExecutionContext が Running 状態から Stopped 状態へ遷移した場合に呼び出される。 このオペレーション呼び出しの結果として onShutdown() コールバック関数が 呼び出される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_activated

public ReturnCode_t on_activated(int ec_id)

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

所属する ExecutionContext から RTC が活性化された際に呼び出される。 このオペレーション呼び出しの結果として onActivated() コールバック関数が 呼び出される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_deactivated

public ReturnCode_t on_deactivated(int ec_id)

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

所属する ExecutionContext から RTC が非活性化された際に 呼び出される。 このオペレーション呼び出しの結果として onDeactivated() コールバック関数が 呼び出される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_aborting

public ReturnCode_t on_aborting(int ec_id)

[ComponentAction CORBA interface] RTC のエラー状態への遷移。

RTC が所属する ExecutionContext が Active 状態から Error 状態へ遷移した場合に呼び出される。 このオペレーションは RTC が Error 状態に遷移した際に一度だけ呼び 出される。 このオペレーション呼び出しの結果として onAborting() コールバック関数が 呼び出される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_error

public ReturnCode_t on_error(int ec_id)

[ComponentAction CORBA interface] RTC のエラー処理

RTC がエラー状態にいる際に呼び出される。 RTC がエラー状態の場合に、対象となる ExecutionContext のExecutionKind に 応じたタイミングで呼び出される。例えば、

• ExecutionKind が PERIODIC の場合、本オペレーションは DataFlowComponentAction::on_execute と on_state_update の替わりに、 設定された順番、設定された周期で呼び出される。
• ExecutionKind が EVENT_DRIVEN の場合、本オペレーションは FsmParticipantAction::on_action が呼ばれた際に、替わりに呼び出される。

このオペレーション呼び出しの結果として onError() コールバック関数が呼び出 される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_reset

public ReturnCode_t on_reset(int ec_id)

[ComponentAction CORBA interface] RTC のリセット。

Error 状態にある RTC のリカバリ処理を実行し、 Inactive 状態に復帰させる場合に呼び出される。 RTC のリカバリ処理が成功した場合は Inactive 状態に復帰するが、それ以外の 場合には Error 状態に留まる。 このオペレーション呼び出しの結果として onReset() コールバック関数が呼び 出される。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_execute

public ReturnCode_t on_execute(int ec_id)

[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)

当該コンポーネントがAvtive状態の間、呼び出されます。

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

実行結果

on_state_update

public ReturnCode_t on_state_update(int ec_id)

[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)。

以下の状態が保持されている場合に、 設定された周期で定期的に呼び出される。

• RTC は Alive 状態である。
• 指定された ExecutionContext が Running 状態である。

本オペレーションは、Two-Pass Execution の第二周期で実行される。 このオペレーション呼び出しの結果として onStateUpdate() コールバック関数が 呼び出される。 制約

• 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければならない

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

on_rate_changed

public ReturnCode_t on_rate_changed(int ec_id)

[DataFlowComponentAction CORBA interface] 実行周期変更通知。

本オペレーションは、ExecutionContext の実行周期が変更されたことを 通知する際に呼び出される。 このオペレーション呼び出しの結果として onRateChanged() コールバック関数が 呼び出される。 制約

• 指定された ExecutionContext の ExecutionKind は、 PERIODIC でなければならない

パラメータ:

ec_id - 対象ExecutionContextのID

戻り値:

ReturnCode_t 型のリターンコード

get_owned_organizations

public Organization[] get_owned_organizations()
                                       throws NotAvailable

[SDO interface] Organization リストの取得。

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

戻り値:

所有している Organization リスト

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_sdo_id

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

[SDO interface] SDO ID の取得。

SDO ID を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。

戻り値:

リソースデータモデルで定義されている SDO の ID

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_sdo_type

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

[SDO interface] SDO タイプの取得。

SDO Type を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。

戻り値:

リソースデータモデルで定義されている SDO の Type

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_device_profile

public DeviceProfile get_device_profile()
                                 throws NotAvailable,
                                        InternalError

[SDO interface] SDO DeviceProfile リストの取得。

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

戻り値:

SDO DeviceProfile

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_service_profiles

public ServiceProfile[] get_service_profiles()
                                      throws NotAvailable,
                                             InternalError

[SDO interface] SDO ServiceProfile の取得。

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

戻り値:

SDO が提供する全ての Service の ServiceProfile。

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_service_profile

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

[SDO interface] 特定のServiceProfileの取得。

引数 "id" で指定された名前のサービスの ServiceProfile を返す。

パラメータ:

id - SDO Service の ServiceProfile に関連付けられた識別子。

戻り値:

指定された SDO Service の ServiceProfile。

例外:

InvalidParameter - "id" で指定した ServiceProfile が存在しない。 "id" が null。

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_sdo_service

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

[SDO interface] 指定された SDO Service の取得。

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

パラメータ:

id - SDO Service に関連付けられた識別子。

戻り値:

要求された SDO Service への参照。

例外:

InvalidParameter - "id" で指定した ServiceProfile が存在しない。 "id" が null。

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_configuration

public Configuration get_configuration()
                                throws InterfaceNotImplemented,
                                       NotAvailable,
                                       InternalError

[SDO 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が存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_monitoring

public Monitoring get_monitoring()
                          throws InterfaceNotImplemented,
                                 NotAvailable,
                                 InternalError

[SDO 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はConfigurationインターフェースを 持たない。

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_organizations

public Organization[] get_organizations()
                                 throws NotAvailable,
                                        InternalError

[SDO interface] Organization リストの取得。

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

戻り値:

SDO が所属する Organization のリスト。

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_status_list

public NameValue[] get_status_list()
                            throws NotAvailable,
                                   InternalError

[SDO interface] SDO Status リストの取得。

このオペレーションは SDO のステータスを表す NVList を返す。

戻り値:

SDO のステータス。

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InternalError - 内部的エラーが発生した。

get_status

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

[SDO interface] SDO Status の取得。

このオペレーションは 引数で指定された SDO のステータスを返す

パラメータ:

name - SDO のステータスを定義するパラメータ。

戻り値:

指定されたパラメータのステータス値。

例外:

SDONotExists - ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)

NotAvailable - SDOは存在するが応答がない。

InvalidParameter - 引数 "name" が null あるいは存在しない。

InternalError - 内部的エラーが発生した。

getInstanceName

public final java.lang.String getInstanceName()

[local interface] インスタンス名の取得。

ComponentProfile に設定されたインスタンス名を返す。

戻り値:

インスタンス名

setInstanceName

public void setInstanceName(java.lang.String instance_name)

[local interface] インスタンス名の設定。

ComponentProfile に指定されたインスタンス名を設定する。

パラメータ:

instance_name - インスタンス名

getTypeName

public final java.lang.String getTypeName()

[local interface] 型名の取得。

ComponentProfile に設定された型名を返す。

戻り値:

型名

getCategory

public final java.lang.String getCategory()

[local interface] カテゴリ情報の取得。

ComponentProfile に設定されたカテゴリ情報を返す。

戻り値:

カテゴリ情報

getNamingNames

public java.lang.String[] getNamingNames()

[local interface] Naming Server 情報の取得。

設定された Naming Server 情報を返す。

戻り値:

Naming Server リスト

setObjRef

public void setObjRef(RTObject rtobj)

[local interface] オブジェクトリファレンスの設定。

RTC の CORBA オブジェクトリファレンスを設定する。

パラメータ:

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

getObjRef

public final RTObject getObjRef()

[local interface] オブジェクトリファレンスの取得。

設定された CORBA オブジェクトリファレンスを取得する。

戻り値:

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

setProperties

public void setProperties(Properties prop)

[local interface] RTC のプロパティを設定する。

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

パラメータ:

prop - RTC のプロパティ

syncAttributesByProperties

protected void syncAttributesByProperties()
                                   throws java.lang.Exception

プロパティを設定する

例外:

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)

コンフィギュレーションパラメータの設定。

コンフィギュレーションパラメータと変数をバインドする \としてコンフィギュレーションパラメータの データ型を指定する。

パラメータ:

param_name - コンフィギュレーションパラメータ名

var - コンフィギュレーションパラメータ格納用変数

def_val - コンフィギュレーションパラメータデフォルト値

戻り値:

設定結果(設定成功:true，設定失敗:false)

updateParameters

public void updateParameters(java.lang.String config_set)

コンフィギュレーションパラメータの更新。

指定したIDのコンフィギュレーションセットに設定した値で、 コンフィギュレーションパラメータの値を更新する

パラメータ:

config_set - 更新対象値

registerPort

public void registerPort(PortBase port)

[local interface] Port を登録する。

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

パラメータ:

port - RTC に登録する Port

addPort

public boolean addPort(PortBase port)

[local interface] Port を登録する。

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

パラメータ:

port - RTC に登録する Port

戻り値:

登録結果(登録成功:true，登録失敗:false)

registerPort

public void registerPort(PortService port)

[local interface] Port を登録する。

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

パラメータ:

port - RTC に登録する Port

addPort

public boolean addPort(PortService port)

[local interface] Port を登録する。

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

パラメータ:

port - RTC に登録する Port

戻り値:

登録結果(登録成功:true，登録失敗:false)

registerPort

public void registerPort(CorbaPort port)

[local interface] Port を登録する。

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

パラメータ:

port - RTC に登録する Port

addPort

public boolean addPort(CorbaPort port)

[local interface] Port を登録する。

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

パラメータ:

port - RTC に登録する Port

戻り値:

登録結果(登録成功:true，登録失敗: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 - InPortの名称

inport - InPortへの参照

例外:

java.lang.Exception

addInPort

public boolean addInPort(java.lang.String name,
                         InPortBase inport)

[local interface] DataInPort を登録する.

RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。

パラメータ:

name - port 名称

inport - 登録対象 DataInPort

戻り値:

登録結果(登録成功:true，登録失敗:false)

registerInPort

public void registerInPort(java.lang.String name,
                           InPortBase inport)
                    throws java.lang.Exception

[local interface] DataInPort を登録します。

RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。

パラメータ:

name - port 名称

inport - 登録対象 DataInPort

例外:

java.lang.Exception

addOutPort

public boolean addOutPort(java.lang.String name,
                          OutPortBase outport)

[local interface] DataOutPort を登録する.

RTC が保持する DataOutPortを登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataOutPort の インスタンスを生成し、登録する。

パラメータ:

name - i port 名称

outport - 登録対象 DataOutPort

戻り値:

登録結果(登録成功:true，登録失敗: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] DataOutPort を登録します。

RTC が保持する DataOutPortを登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataOutPort の インスタンスを生成し、登録する。

パラメータ:

name - port 名称

outport - 登録対象 DataOutPort

例外:

java.lang.Exception

removeInPort

public boolean removeInPort(InPortBase port)

[local interface] InPort の登録を削除する

RTC が保持するInPortの登録を削除する。

パラメータ:

port - 削除対象 Port

戻り値:

削除結果(削除成功:true，削除失敗:false)

removeOutPort

public boolean removeOutPort(OutPortBase port)

[local interface] OutPort の登録を削除する

RTC が保持するOutPortの登録を削除する。

パラメータ:

port - 削除対象 Port

戻り値:

削除結果(削除成功:true，削除失敗:false)

removePort

public boolean removePort(PortBase port)

[local interface] Port の登録を削除する

RTC が保持するPortの登録を削除する。

パラメータ:

port - 削除対象 Port

戻り値:

削除結果(削除成功:true，削除失敗:false)

removePort

public boolean removePort(PortService port)

[local interface] Port の登録を削除する

RTC が保持するPortの登録を削除する。

パラメータ:

port - 削除対象 Port

戻り値:

削除結果(削除成功:true，削除失敗:false)

removePort

public boolean removePort(CorbaPort port)

[local interface] Port の登録を削除する

RTC が保持するPortの登録を削除する。

パラメータ:

port - 削除対象 Port

戻り値:

削除結果(削除成功:true，削除失敗:false)

deletePort

public void deletePort(PortBase port)

[local interface] Port の登録を削除します。

RTC が保持するPortの登録を削除します。

パラメータ:

port - 削除対象 Port

deletePort

public void deletePort(PortService port)

[local interface] Port の登録を削除します。

RTC が保持するPortの登録を削除します。

パラメータ:

port - 削除対象 Port

deletePort

public void deletePort(CorbaPort port)

[local interface] Port の登録を削除します。

RTC が保持するPortの登録を削除します。

パラメータ:

port - 削除対象 Port

deletePortByName

public void deletePortByName(java.lang.String port_name)

[local interface] 名前指定により Port の登録を削除する。

名称を指定して RTC が保持するPortの登録を削除する。

パラメータ:

port_name - 削除対象 Port 名

readAll

public boolean readAll()

全 InPort のデータを読み込む。

RTC が保持する全ての InPort のデータを読み込む。

戻り値:

読み込み結果(全ポートの読み込み成功:true，失敗:false)

writeAll

public boolean writeAll()

全 OutPort のwrite()メソッドをコールする。

RTC が保持する全ての OutPort のwrite()メソッドをコールする。

戻り値:

読み込み結果(全ポートへの書き込み成功:true，失敗:false)

setReadAll

public void setReadAll(boolean read,
                       boolean completion)

onExecute()実行前でのreadAll()メソッドの呼出を有効または 無効にする。

このメソッドをパラメータをtrueとして呼ぶ事により、 onExecute()実行前に readAll()が呼出されるようになる。 パラメータがfalseの場合は、readAll()呼出を無効にする。

パラメータ:

read - (default:true) (readAll()メソッド呼出あり:true, readAll()メソッド呼出なし:false)

completion - (default:false) readAll()にて、どれかの一つのInPortのread()が失敗しても 全てのInPortのread()を呼び出す:true, readAll()にて、どれかの一つのInPortのread()が失敗した場合、 すぐにfalseで抜ける:false

setReadAll

public void setReadAll()

onExecute()実行前でのreadAll()メソッドの呼出を有効または 無効にする。

readAll()メソッド呼出あり、 readAll()にて、どれかの一つのInPortのread()が失敗した場合、 すぐにfalseで抜ける

setReadAll

public void setReadAll(boolean read)

onExecute()実行前でのreadAll()メソッドの呼出を有効または 無効にする。

readAll()にて、どれかの一つのInPortのread()が失敗した場合、 すぐにfalseで抜ける

パラメータ:

read - (default:true) (readAll()メソッド呼出あり:true, readAll()メソッド呼出なし:false)

setWriteAll

public void setWriteAll(boolean write,
                        boolean completion)

onExecute()実行後にwriteAll()メソッドの呼出を有効または 無効にする。

このメソッドをパラメータをtrueとして呼ぶ事により、 onExecute()実行後にwriteAll()が呼出されるようになる。 パラメータがfalseの場合は、writeAll()呼出を無効にする。

パラメータ:

write - (default:true) (writeAll()メソッド呼出あり:true, writeAll()メソッド呼出なし:false)

completion - (default:false) writeAll()にて、どれかの一つのOutPortのwrite()が失敗しても 全てのOutPortのwrite()を呼び出しを行う:true, writeAll()にて、どれかの一つのOutPortのwrite()が失敗した場合、 すぐにfalseで抜ける:false

setWriteAll

public void setWriteAll()

onExecute()実行後にwriteAll()メソッドの呼出を有効または 無効にする。

writeAll()メソッド呼出あり、 writeAll()にて、どれかの一つのOutPortのwrite()が失敗した場合、 すぐにfalseで抜ける

setWriteAll

public void setWriteAll(boolean write)

onExecute()実行後にwriteAll()メソッドの呼出を有効または 無効にする。

writeAll()にて、どれかの一つのOutPortのwrite()が失敗した場合、 すぐにfalseで抜ける

パラメータ:

write - (default:true) (writeAll()メソッド呼出あり:true, writeAll()メソッド呼出なし:false)

finalizePorts

public void finalizePorts()

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

RTC が保持する全ての Port を削除する。

finalizeContexts

public void finalizeContexts()

ExecutionContextBaseリストの登録を削除する

addPreComponentActionListener

public void addPreComponentActionListener(int listener_type,
                                          PreComponentActionListener listener,
                                          boolean autoclean)

PreComponentActionListener リスナを追加する

ComponentAction 実装関数の呼び出し直前のイベントに関連する各種リ スナを設定する。 設定できるリスナのタイプとコールバックイベントは以下の通り

• PRE_ON_INITIALIZE: onInitialize 直前
• PRE_ON_FINALIZE: onFinalize 直前
• PRE_ON_STARTUP: onStartup 直前
• PRE_ON_SHUTDOWN: onShutdown 直前
• PRE_ON_ACTIVATED: onActivated 直前
• PRE_ON_DEACTIVATED: onDeactivated 直前
• PRE_ON_ABORTED: onAborted 直前
• PRE_ON_ERROR: onError 直前
• PRE_ON_RESET: onReset 直前
• PRE_ON_EXECUTE: onExecute 直前
• PRE_ON_STATE_UPDATE: onStateUpdate 直前

リスナは PreComponentActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。 PreComponentActionListener::operator()(int ec_id) デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePreComponentActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

autoclean - リスナオブジェクトの自動的解体を行うかどうかのフラグ

addPreComponentActionListener

public void addPreComponentActionListener(int listener_type,
                                          PreComponentActionListener listener)

removePreComponentActionListener

public void removePreComponentActionListener(int listener_type,
                                             PreComponentActionListener listener)

PreComponentActionListener リスナを削除する

設定した各種リスナを削除する。

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

addPostComponentActionListener

public void addPostComponentActionListener(int listener_type,
                                           PostComponentActionListener listener,
                                           boolean autoclean)

PostComponentActionListener リスナを追加する

ComponentAction 実装関数の呼び出し直後のイベントに関連する各種リ スナを設定する。 設定できるリスナのタイプとコールバックイベントは以下の通り

• POST_ON_INITIALIZE: onInitialize 直後
• POST_ON_FINALIZE: onFinalize 直後
• POST_ON_STARTUP: onStartup 直後
• POST_ON_SHUTDOWN: onShutdown 直後
• POST_ON_ACTIVATED: onActivated 直後
• POST_ON_DEACTIVATED: onDeactivated 直後
• POST_ON_ABORTED: onAborted 直後
• POST_ON_ERROR: onError 直後
• POST_ON_RESET: onReset 直後
• POST_ON_EXECUTE: onExecute 直後
• POST_ON_STATE_UPDATE: onStateUpdate 直後

リスナは PostComponentActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。 PostComponentActionListener::operator()(int ec_id, ReturnCode_t ret) デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePostComponentActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。 {This operation adds certain listeners related to ComponentActions post events. The following listener types are available.

• POST_ON_INITIALIZE: after onInitialize
• POST_ON_FINALIZE: after onFinalize
• POST_ON_STARTUP: after onStartup
• POST_ON_SHUTDOWN: after onShutdown
• POST_ON_ACTIVATED: after onActivated
• POST_ON_DEACTIVATED: after onDeactivated
• POST_ON_ABORTED: after onAborted
• POST_ON_ERROR: after onError
• POST_ON_RESET: after onReset
• POST_ON_EXECUTE: after onExecute
• POST_ON_STATE_UPDATE: after onStateUpdate

Listeners should have the following function operator(). PostComponentActionListener::operator()(int ec_id, ReturnCode_t ret) The ownership of the given listener object is transferred to this RTObject object in default. The given listener object will be destroied automatically in the RTObject's dtor or if the listener is deleted by removePostComponentActionListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.}

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

autoclean - リスナオブジェクトの自動的解体を行うかどうかのフラグ

addPostComponentActionListener

public void addPostComponentActionListener(int listener_type,
                                           PostComponentActionListener listener)

removePostComponentActionListener

public void removePostComponentActionListener(int listener_type,
                                              PostComponentActionListener listener)

PostComponentActionListener リスナを削除する

設定した各種リスナを削除する。

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

addPortActionListener

public void addPortActionListener(int listener_type,
                                  PortActionListener listener,
                                  boolean autoclean)

PortActionListener リスナを追加する

Portの追加、削除時にコールバックされる各種リスナを設定する。 設定できるリスナのタイプとコールバックイベントは以下の通り

• ADD_PORT: Port追加時
• REMOVE_PORT: Port削除時 リスナは PortActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。 PortActionListener::operator()(PortProfile& pprof) デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。

  パラメータ:

  listener_type - リスナタイプ

  listener - リスナオブジェクトへのポインタ

  autoclean - リスナオブジェクトの自動的解体を行うかどうかのフラグ

addPortActionListener

public void addPortActionListener(int listener_type,
                                  PortActionListener listener)

removePortActionListener

public void removePortActionListener(int listener_type,
                                     PortActionListener listener)

PortActionListener リスナを削除する

設定した各種リスナを削除する。

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

addExecutionContextActionListener

public void addExecutionContextActionListener(int listener_type,
                                              ExecutionContextActionListener listener,
                                              boolean autoclean)

ExecutionContextActionListener リスナを追加する

ExecutionContextの追加、削除時にコールバックされる各種リスナを設定する。 設定できるリスナのタイプとコールバックイベントは以下の通り

• ATTACH_EC: ExecutionContext アタッチ時
• DETACH_EC: ExecutionContext デタッチ時

リスナは ExecutionContextActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。 ExecutionContextActionListener::operator()(int　ec_id) デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeExecutionContextActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

autoclean - リスナオブジェクトの自動的解体を行うかどうかのフラグ

addExecutionContextActionListener

public void addExecutionContextActionListener(int listener_type,
                                              ExecutionContextActionListener listener)

removeExecutionContextActionListener

public void removeExecutionContextActionListener(int listener_type,
                                                 ExecutionContextActionListener listener)

ExecutionContextActionListener リスナを削除する

設定した各種リスナを削除する。

パラメータ:

listener_type - リスナタイプ

listener - リスナオブジェクトへのポインタ

shutdown

protected void shutdown()

RTC を終了する。

RTC の終了処理を実行する。 保持している全 Port の登録を解除するとともに、該当する CORBA オブジェクト を非活性化し、RTC を終了する。

preOnInitialize

protected void preOnInitialize(int ec_id)

preOnFinalize

protected void preOnFinalize(int ec_id)

preOnStartup

protected void preOnStartup(int ec_id)

preOnShutdown

protected void preOnShutdown(int ec_id)

preOnActivated

protected void preOnActivated(int ec_id)

preOnDeactivated

protected void preOnDeactivated(int ec_id)

preOnAborting

protected void preOnAborting(int ec_id)

preOnError

protected void preOnError(int ec_id)

preOnReset

protected void preOnReset(int ec_id)

preOnExecute

protected void preOnExecute(int ec_id)

preOnStateUpdate

protected void preOnStateUpdate(int ec_id)

preOnRateChanged

protected void preOnRateChanged(int ec_id)

postOnInitialize

protected void postOnInitialize(int ec_id,
                                ReturnCode_t ret)

postOnFinalize

protected void postOnFinalize(int ec_id,
                              ReturnCode_t ret)

postOnStartup

protected void postOnStartup(int ec_id,
                             ReturnCode_t ret)

postOnShutdown

protected void postOnShutdown(int ec_id,
                              ReturnCode_t ret)

postOnActivated

protected void postOnActivated(int ec_id,
                               ReturnCode_t ret)

postOnDeactivated

protected void postOnDeactivated(int ec_id,
                                 ReturnCode_t ret)

postOnAborting

protected void postOnAborting(int ec_id,
                              ReturnCode_t ret)

postOnError

protected void postOnError(int ec_id,
                           ReturnCode_t ret)

postOnReset

protected void postOnReset(int ec_id,
                           ReturnCode_t ret)

postOnExecute

protected void postOnExecute(int ec_id,
                             ReturnCode_t ret)

postOnStateUpdate

protected void postOnStateUpdate(int ec_id,
                                 ReturnCode_t ret)

postOnRateChanged

protected void postOnRateChanged(int ec_id,
                                 ReturnCode_t ret)

onAddPort

protected void onAddPort(PortProfile pprof)

onRemovePort

protected void onRemovePort(PortProfile pprof)

onAttachExecutionContext

protected void onAttachExecutionContext(int ec_id)

onDetachExecutionContext

protected void onDetachExecutionContext(int ec_id)