|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectorg.omg.PortableServer.Servant
RTC.DataFlowComponentPOA
jp.go.aist.rtm.RTC.RTObject_impl
public class RTObject_impl
DataFlowComponentのベースクラスです。 ユーザが新たなRTコンポーネントを作成する場合は、このクラスを拡張します。
コンストラクタの概要 | |
---|---|
RTObject_impl(Manager manager)
コンストラクタです。 |
|
RTObject_impl(org.omg.CORBA.ORB orb,
org.omg.PortableServer.POA poa)
コンストラクタです。 |
メソッドの概要 | ||
---|---|---|
ReturnCode_t |
_finalize()
RTコンポーネントを終了します。 |
|
int |
attach_executioncontext(ExecutionContext exec_context)
[CORBA interface] 当該コンポーネントをExecutionContextにattachします。 |
|
boolean |
bindParameter(java.lang.String param_name,
ValueHolder var,
java.lang.String def_val)
コンフィギュレーション・パラメータをbindします。 |
|
void |
deletePort(PortBase port)
[local interface] Port の登録を削除します。 |
|
void |
deletePortByName(java.lang.String port_name)
[local interface] 名称によって指定された Port の登録を削除します。 |
|
ReturnCode_t |
detach_executioncontext(int ec_id)
[CORBA interface] 当該コンポーネントをExecutionContextからdetachします。 |
|
ReturnCode_t |
exit()
RTコンポーネントを停止し、そのコンテンツとともに終了します。 |
|
void |
finalizePorts()
登録されているすべてのPortの登録を削除します。 |
|
ComponentProfile |
get_component_profile()
[RTObject CORBA interface] 当該コンポーネントのプロファイル情報を取得します。 |
|
Configuration |
get_configuration()
[CORBA interface] Configuration オブジェクト を取得します。 |
|
ExecutionContext |
get_context(int ec_id)
[CORBA interface] ExecutionContextを取得します。 |
|
ExecutionContext[] |
get_contexts()
[CORBA interface] ExecutionContextListを取得します。 |
|
DeviceProfile |
get_device_profile()
[CORBA interface] SDO DeviceProfile リストを取得します。 |
|
ExecutionContextService[] |
get_execution_context_services()
[RTObject CORBA interface] 当該コンポーネントが所属する ExecutionContextに関連した ExecutionContextService のリストを取得します。 |
|
Monitoring |
get_monitoring()
[CORBA interface] Monitoring オブジェクト を取得します。 |
|
Organization[] |
get_organizations()
[CORBA interface] Organization リスト を取得します。 |
|
Organization[] |
get_owned_organizations()
[CORBA interface] Organization リストを取得します。 |
|
Port[] |
get_ports()
[RTObject CORBA interface] 当該コンポーネントが保有するポートの参照を取得します。 |
|
java.lang.String |
get_sdo_id()
[CORBA interface] SDO IDを取得します。 |
|
SDOService |
get_sdo_service(java.lang.String id)
[CORBA interface] 指定された SDO Service を取得します。 |
|
java.lang.String |
get_sdo_type()
[CORBA interface] SDO タイプを取得します。 |
|
ServiceProfile |
get_service_profile(java.lang.String id)
[CORBA interface] 特定のServiceProfile を取得します。 |
|
ServiceProfile[] |
get_service_profiles()
[CORBA interface] SDO ServiceProfile を取得します。 |
|
NameValue[] |
get_status_list()
[CORBA interface] SDO Status リスト を取得します。 |
|
org.omg.CORBA.Any |
get_status(java.lang.String name)
[CORBA interface] SDO Status を取得します。 |
|
java.lang.String |
getCategory()
当該オブジェクトのカテゴリを取得します。 |
|
java.lang.String |
getInstanceName()
当該オブジェクトのインスタンス名を取得します。 |
|
java.lang.String[] |
getNamingNames()
当該オブジェクトのNaming Seriveへの登録名を取得します。 |
|
RTObject |
getObjRef()
CORBAオブジェクト参照を取得します。 |
|
Properties |
getProperties()
[local interface] RTC のプロパティを取得します。 |
|
java.lang.String |
getTypeName()
当該オブジェクトの型名を取得します。 |
|
ReturnCode_t |
initialize()
RTコンポーネントを初期化します。 |
|
boolean |
is_alive()
RTコンポーネントがAlive状態であるか判断します。 |
|
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)
[ComponentAction interface] 当該コンポーネントがAvtive状態の間、呼び出されます。 |
|
ReturnCode_t |
on_finalize()
[ComponentAction interface] 当該コンポーネントの終了時に呼び出されます。 |
|
ReturnCode_t |
on_initialize()
[ComponentAction interface] 当該コンポーネントの初期化時に呼び出されます。 |
|
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の後に呼び出されます。 |
|
|
registerInPort(java.lang.Class<DataType> DATA_TYPE_CLASS,
java.lang.String name,
InPort<DataType> inport)
[local interface] DataInPort を登録します。 |
|
|
registerOutPort(java.lang.Class<DataType> DATA_TYPE_CLASS,
java.lang.String name,
OutPort<DataType> outport)
[local interface] DataOutPort を登録します。 |
|
void |
registerPort(PortBase port)
[local interface] Port を登録します。 |
|
void |
setInstanceName(java.lang.String instance_name)
当該オブジェクトのインスタンス名を設定します。 |
|
void |
setObjRef(RTObject rtobj)
CORBAオブジェクト参照を設定します。 |
|
void |
setProperties(Properties prop)
[local interface] RTC のプロパティを設定します。 |
|
void |
updateParameters(java.lang.String config_set)
コンフィギュレーション・パラメータを更新します。 |
クラス RTC.DataFlowComponentPOA から継承されたメソッド |
---|
_all_interfaces, _invoke, _this, _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 から継承されたメソッド |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public RTObject_impl(Manager manager)
コンストラクタです。
manager
- Managerオブジェクトpublic RTObject_impl(org.omg.CORBA.ORB orb, org.omg.PortableServer.POA poa)
コンストラクタです。
orb
- ORBpoa
- POAメソッドの詳細 |
---|
public ReturnCode_t initialize()
RTコンポーネントを初期化します。
このオペレーション呼び出しの結果として、ComponentAction::on_initialize
コールバック関数が呼ばれます。
制約
Created状態にいるときにのみ、初期化が行われます。他の状態にいる場合には
ReturnCode_t::PRECONDITION_NOT_MET が返され呼び出しは失敗します。
このオペレーションはRTCのミドルウエアから呼ばれることを想定しており、
アプリケーション開発者は直接このオペレーションを呼ぶことは想定
されていません。
public ReturnCode_t _finalize()
RTコンポーネントを終了します。
このオペレーション呼び出しの結果として、ComponentAction::on_finalize
コールバック関数が呼ばれます。
制約
public ReturnCode_t exit()
RTコンポーネントを停止し、そのコンテンツとともに終了します。
この RTC がオーナーであるすべての実行コンテキストが停止されます。
この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト
(i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの
オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上
で非活性化されなければなりません。
制約
public boolean is_alive()
RTコンポーネントがAlive状態であるか判断します。
RTコンポーネントがAliveであるかどうかは、
ExecutionContextの状態(Inactive,Active,Error)とは独立しています。
1つのRTコンポーネントが、複数のExecutionContextにattachされる場合もあるため、
ExecutionContextの状態が混在する場合
(ExecutionContext1に対してはActive、ExecutionContext2に対してはInactiveなど)
があるためです。
public ExecutionContext[] get_contexts()
[CORBA interface] ExecutionContextListを取得します。
public ExecutionContext get_context(int ec_id)
[CORBA interface] ExecutionContextを取得します。
ec_id
- ExecutionContextのID
public ComponentProfile get_component_profile()
[RTObject CORBA interface] 当該コンポーネントのプロファイル情報を取得します。
public Port[] get_ports()
[RTObject CORBA interface] 当該コンポーネントが保有するポートの参照を取得します。
public ExecutionContextService[] get_execution_context_services()
[RTObject CORBA interface] 当該コンポーネントが所属する ExecutionContextに関連した ExecutionContextService のリストを取得します。
public int attach_executioncontext(ExecutionContext exec_context)
[CORBA interface] 当該コンポーネントをExecutionContextにattachします。
exec_context
- attach対象ExecutionContext
public ReturnCode_t detach_executioncontext(int ec_id)
[CORBA interface] 当該コンポーネントをExecutionContextからdetachします。
ec_id
- detach対象ExecutionContextのID
public ReturnCode_t on_initialize()
[ComponentAction interface] 当該コンポーネントの初期化時に呼び出されます。
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)
[ComponentAction interface] 当該コンポーネントがAvtive状態の間、呼び出されます。
ec_id
- 対象ExecutionContextのID
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)
当該オブジェクトのインスタンス名を設定します。
インスタンス名
- 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 のプロパティ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)
[local interface] Port を登録します。
RTC が保持するPortを登録します。
Port を外部からアクセス可能にするためには、このオペレーションにより
登録されていなければなりません。登録される Port はこの RTC 内部において
PortProfile.name により区別されます。したがって、Port は RTC 内において、
ユニークな PortProfile.name を持たなければなりません。
登録された Port は内部で適切にアクティブ化された後、その参照と
オブジェクト参照がリスト内に保存されます。
port
- RTC に登録する Portpublic <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 <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の名称inport
- OutPortへの参照
java.lang.Exception
public void deletePort(PortBase port)
[local interface] Port の登録を削除します。
RTC が保持するPortの登録を削除します。
port
- RTC に登録する Portpublic void deletePortByName(java.lang.String port_name)
[local interface] 名称によって指定された Port の登録を削除します。
port_name
- 削除対象のポート名public void finalizePorts()
登録されているすべてのPortの登録を削除します。
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |