クラス RTObject_impl

RTコンポーネントクラス [詳細]


Public メソッド

def __init__
 コンストラクタ
def __del__
 デストラクタ
def onInitialize
 初期化処理用コールバック関数
def onFinalize
 終了処理用コールバック関数
def onStartup
 開始処理用コールバック関数
def onShutdown
 停止処理用コールバック関数
def onActivated
 活性化処理用コールバック関数
def onDeactivated
 非活性化処理用コールバック関数
def onExecute
 周期処理用コールバック関数
def onAborting
 中断処理用コールバック関数
def onError
 エラー処理用コールバック関数
def onReset
 リセット処理用コールバック関数
def onStateUpdate
 状態変更処理用コールバック関数
def onRateChanged
 動作周期変更通知用コールバック関数
def initialize
 [CORBA interface] RTCを初期化する
def finalize
 [CORBA interface] RTC を終了する
def exit
 [CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる
def is_alive
 [CORBA interface] RTC が Alive 状態であるかどうか確認する。
def get_contexts
 [CORBA interface] ExecutionContextListを取得する
def get_context
 [CORBA interface] ExecutionContextを取得する
def get_component_profile
 [RTObject CORBA interface] コンポーネントプロファイルを取得する
def get_ports
 [RTObject CORBA interface] ポートを取得する
def get_execution_context_services
 [RTObject CORBA interface] ExecutionContextAdmin を取得する
def attach_executioncontext
 [CORBA interface] ExecutionContextをattachする
def detach_executioncontext
 [CORBA interface] ExecutionContextをdetachする
def on_initialize
 [ComponentAction CORBA interface] RTC の初期化
def on_finalize
 [ComponentAction CORBA interface] RTC の終了
def on_startup
 [ComponentAction CORBA interface] RTC の開始
def on_shutdown
 [ComponentAction CORBA interface] RTC の停止
def on_activated
 [ComponentAction CORBA interface] RTC の活性化
def on_deactivated
 [ComponentAction CORBA interface] RTC の非活性化
def on_aborting
 [ComponentAction CORBA interface] RTC のエラー状態への遷移
def on_error
 [ComponentAction CORBA interface] RTC のエラー処理
def on_reset
 [ComponentAction CORBA interface] RTC のリセット
def on_execute
 [DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)
def on_state_update
 [DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)
def on_rate_changed
 [DataFlowComponentAction CORBA interface] 実行周期変更通知
def get_owned_organizations
 [SDO interface] Organization リストの取得
def get_sdo_id
 [SDO interface] SDO ID の取得
def get_sdo_type
 [SDO interface] SDO タイプの取得
def get_device_profile
 [SDO interface] SDO DeviceProfile リストの取得
def get_service_profiles
 [SDO interface] SDO ServiceProfile の取得
def get_service_profile
 [SDO interface] 特定のServiceProfileの取得
def get_sdo_service
 [SDO interface] 指定された SDO Service の取得
def get_configuration
 [SDO interface] Configuration オブジェクトの取得
def get_monitoring
 [SDO interface] Monitoring オブジェクトの取得
def get_organizations
 [SDO interface] Organization リストの取得
def get_status_list
 [SDO interface] SDO Status リストの取得
def get_status
 [SDO interface] SDO Status の取得
def getInstanceName
 [local interface] インスタンス名の取得
def setInstanceName
 [local interface] インスタンス名の設定
def getTypeName
 [local interface] 型名の取得
def getDescription
 [local interface] Description の取得
def getVersion
 [local interface] バージョン情報の取得
def getVendor
 [local interface] ベンダー情報の取得
def getCategory
 [local interface] カテゴリ情報の取得
def getNamingNames
 [local interface] Naming Server 情報の取得
def setObjRef
 [local interface] オブジェクトリファレンスの設定
def getObjRef
 [local interface] オブジェクトリファレンスの取得
def setProperties
 [local interface] RTC のプロパティを設定する
def getProperties
 [local interface] RTC のプロパティを取得する
def bindParameter
 コンフィギュレーションパラメータの設定
def updateParameters
 コンフィギュレーションパラメータの更新(ID指定)
def registerPort
 [local interface] Port を登録する
def registerInPort
 [local interface] DataInPort を登録する
def registerOutPort
 [local interface] DataOutPort を登録する
def deletePort
 [local interface] Port の登録を削除する
def deletePortByName
 [local interface] 名前指定により Port の登録を削除する
def finalizePorts
 全 Port の登録を削除する
def shutdown
 RTC を終了する

データ構造

class  deactivate_comps
 RTC 非活性化用ファンクタ [詳細]
class  ec_copy
 ExecutionContext 検索用ファンクタ [詳細]
class  nv_name
 NVList 検索用ファンクタ [詳細]
class  svc_name
 SDOService のプロファイルリストからidでサーチするための ファンクタクラス [詳細]


説明

RTコンポーネントクラス

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

から:
0.2.0

RTObject.py64 行で定義されています。


関数

def __init__ (   self,
  manager = None,
  orb = None,
  poa = None 
)

コンストラクタ

コンストラクタ

引数:
self 
manager マネージャオブジェクト(デフォルト値:None)
orb ORB(デフォルト値:None)
poa POA(デフォルト値:None)

RTObject.py87 行で定義されています。

def __del__ (   self  ) 

デストラクタ

引数:
self 

RTObject.py129 行で定義されています。

def onInitialize (   self  ) 

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

ComponentAction::on_initialize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の初期化処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py155 行で定義されています。

def onFinalize (   self  ) 

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

ComponentAction::on_finalize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の終了処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py177 行で定義されています。

def onStartup (   self,
  ec_id 
)

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

ComponentAction::on_startup が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の開始処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py200 行で定義されています。

def onShutdown (   self,
  ec_id 
)

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

ComponentAction::on_shutdown が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の停止処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py223 行で定義されています。

def onActivated (   self,
  ec_id 
)

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

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

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py246 行で定義されています。

def onDeactivated (   self,
  ec_id 
)

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

ComponentAction::on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の非活性化処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py269 行で定義されています。

def onExecute (   self,
  ec_id 
)

周期処理用コールバック関数

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

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py294 行で定義されています。

def onAborting (   self,
  ec_id 
)

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

ComponentAction::on_aborting が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の中断処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py317 行で定義されています。

def onError (   self,
  ec_id 
)

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

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

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py339 行で定義されています。

def onReset (   self,
  ec_id 
)

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

ComponentAction::on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドして実装する 必要がある。

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py361 行で定義されています。

def onStateUpdate (   self,
  ec_id 
)

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

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

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py386 行で定義されています。

def onRateChanged (   self,
  ec_id 
)

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

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

引数:
self 
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py411 行で定義されています。

def initialize (   self  ) 

[CORBA interface] RTCを初期化する

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

制約

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py455 行で定義されています。

def finalize (   self  ) 

[CORBA interface] RTC を終了する

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

制約

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py512 行で定義されています。

def exit (   self  ) 

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

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

制約

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py569 行で定義されています。

def is_alive (   self  ) 

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

RTC が指定した ExecutionContext に対して Alive状態であるかどうか確認する。 RTC の状態が Active であるか、Inactive であるか、Error であるかは実行中の ExecutionContext に依存する。すなわち、ある ExecutionContext に対しては Active 状態であっても、他の ExecutionContext に対しては Inactive 状態と なる場合もありえる。従って、このオペレーションは指定された ExecutionContext に問い合わせて、この RTC の状態が Active、Inactive、 Error の場合には Alive 状態として返す。

引数:
self 
戻り値:
Alive 状態確認結果

RTObject.py612 行で定義されています。

def get_contexts (   self  ) 

[CORBA interface] ExecutionContextListを取得する

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

引数:
self 
戻り値:
ExecutionContext リスト

RTObject.py634 行で定義されています。

def get_context (   self,
  ec_id 
)

[CORBA interface] ExecutionContextを取得する

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

引数:
self 
ec_id 取得対象 ExecutionContext ハンドル
戻り値:
ExecutionContext

RTObject.py667 行で定義されています。

def get_component_profile (   self  ) 

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

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

引数:
self 
戻り値:
コンポーネントプロファイル

RTObject.py698 行で定義されています。

def get_ports (   self  ) 

[RTObject CORBA interface] ポートを取得する

当該コンポーネントが保有するポートの参照を返す。

引数:
self 
戻り値:
ポートリスト

RTObject.py736 行で定義されています。

def get_execution_context_services (   self  ) 

[RTObject CORBA interface] ExecutionContextAdmin を取得する

このオペレーションは当該 RTC が所属する ExecutionContextに関連した ExecutionContextService のリストを返す。

引数:
self 
戻り値:
ExecutionContextService リスト

RTObject.py768 行で定義されています。

def attach_executioncontext (   self,
  exec_context 
)

[CORBA interface] ExecutionContextをattachする

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

引数:
self 
exec_context 所属先 ExecutionContext
戻り値:
ExecutionContext ハンドル

RTObject.py810 行で定義されています。

def detach_executioncontext (   self,
  ec_id 
)

[CORBA interface] ExecutionContextをdetachする

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

制約

引数:
self 
ec_id 解除対象 ExecutionContextハンドル
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py861 行で定義されています。

def on_initialize (   self  ) 

[ComponentAction CORBA interface] RTC の初期化

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

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py896 行で定義されています。

def on_finalize (   self  ) 

[ComponentAction CORBA interface] RTC の終了

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

引数:
self 
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py930 行で定義されています。

def on_startup (   self,
  ec_id 
)

[ComponentAction CORBA interface] RTC の開始

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

引数:
self 
ec_id 状態遷移した ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py967 行で定義されています。

def on_shutdown (   self,
  ec_id 
)

[ComponentAction CORBA interface] RTC の停止

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

引数:
self 
ec_id 状態遷移した ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1004 行で定義されています。

def on_activated (   self,
  ec_id 
)

[ComponentAction CORBA interface] RTC の活性化

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

引数:
self 
ec_id 活性化 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1039 行で定義されています。

def on_deactivated (   self,
  ec_id 
)

[ComponentAction CORBA interface] RTC の非活性化

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

引数:
self 
ec_id 非活性化 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1075 行で定義されています。

def on_aborting (   self,
  ec_id 
)

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

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

引数:
self 
ec_id 状態遷移した ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1116 行で定義されています。

def on_error (   self,
  ec_id 
)

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

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

引数:
self 
ec_id 対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1168 行で定義されています。

def on_reset (   self,
  ec_id 
)

[ComponentAction CORBA interface] RTC のリセット

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

引数:
self 
ec_id リセット対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1210 行で定義されています。

def on_execute (   self,
  ec_id 
)

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

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

制約

引数:
self 
ec_id 定常処理対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1260 行で定義されています。

def on_state_update (   self,
  ec_id 
)

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

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

制約

引数:
self 
ec_id 定常処理対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1310 行で定義されています。

def on_rate_changed (   self,
  ec_id 
)

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

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

制約

引数:
self 
ec_id 定常処理対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

RTObject.py1355 行で定義されています。

def get_owned_organizations (   self  ) 

[SDO interface] Organization リストの取得

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

引数:
self 
戻り値:
所有している Organization リスト
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1408 行で定義されています。

def get_sdo_id (   self  ) 

[SDO interface] SDO ID の取得

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

引数:
self 
戻り値:
リソースデータモデルで定義されている SDO の ID
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1456 行で定義されています。

def get_sdo_type (   self  ) 

[SDO interface] SDO タイプの取得

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

引数:
self 
戻り値:
リソースデータモデルで定義されている SDO の Type
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1498 行で定義されています。

def get_device_profile (   self  ) 

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

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

引数:
self 
戻り値:
SDO DeviceProfile
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1544 行で定義されています。

def get_service_profiles (   self  ) 

[SDO interface] SDO ServiceProfile の取得

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

引数:
self 
戻り値:
SDO が提供する全ての Service の ServiceProfile。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1596 行で定義されています。

def get_service_profile (   self,
  _id 
)

[SDO interface] 特定のServiceProfileの取得

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

引数:
self 
_id SDO Service の ServiceProfile に関連付けられた識別子。
戻り値:
指定された SDO Service の ServiceProfile。
例外:
InvalidParameter "id" で指定した ServiceProfile が存在しない。 "id" が null。
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1647 行で定義されています。

def get_sdo_service (   self,
  _id 
)

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

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

引数:
self 
_id SDO Service に関連付けられた識別子。
戻り値:
要求された SDO Service への参照。
例外:
InvalidParameter "id" で指定した ServiceProfile が存在しない。 "id" が null。
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1710 行で定義されています。

def get_configuration (   self  ) 

[SDO interface] Configuration オブジェクトの取得

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

引数:
self 
戻り値:
SDO の Configuration インターフェースへの参照
例外:
InterfaceNotImplemented SDOはConfigurationインターフェースを 持たない。
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1771 行で定義されています。

def get_monitoring (   self  ) 

[SDO interface] Monitoring オブジェクトの取得

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

引数:
self 
戻り値:
SDO の Monitoring interface への参照
例外:
InterfaceNotImplemented SDOはConfigurationインターフェースを 持たない。
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1825 行で定義されています。

def get_organizations (   self  ) 

[SDO interface] Organization リストの取得

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

引数:
self 
戻り値:
SDO が所属する Organization のリスト。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1866 行で定義されています。

def get_status_list (   self  ) 

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

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

引数:
self 
戻り値:
SDO のステータス。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject.py1906 行で定義されています。

def get_status (   self,
  name 
)

[SDO interface] SDO Status の取得

This operation returns the value of the specified status parameter.

引数:
self 
name SDO のステータスを定義するパラメータ。
戻り値:
指定されたパラメータのステータス値。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InvalidParameter 引数 "name" が null あるいは存在しない。
InternalError 内部的エラーが発生した。

RTObject.py1950 行で定義されています。

def getInstanceName (   self  ) 

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

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

引数:
self 
戻り値:
インスタンス名

RTObject.py1980 行で定義されています。

def setInstanceName (   self,
  instance_name 
)

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

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

引数:
self 
instance_name インスタンス名

RTObject.py1998 行で定義されています。

def getTypeName (   self  ) 

[local interface] 型名の取得

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

引数:
self 
戻り値:
型名

RTObject.py2017 行で定義されています。

def getDescription (   self  ) 

[local interface] Description の取得

ComponentProfile に設定された Description を返す。

引数:
self 
戻り値:
Description

RTObject.py2035 行で定義されています。

def getVersion (   self  ) 

[local interface] バージョン情報の取得

ComponentProfile に設定されたバージョン情報を返す。

引数:
self 
戻り値:
バージョン情報

RTObject.py2053 行で定義されています。

def getVendor (   self  ) 

[local interface] ベンダー情報の取得

ComponentProfile に設定されたベンダー情報を返す。

引数:
self 
戻り値:
ベンダー情報

RTObject.py2071 行で定義されています。

def getCategory (   self  ) 

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

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

引数:
self 
戻り値:
カテゴリ情報

RTObject.py2089 行で定義されています。

def getNamingNames (   self  ) 

[local interface] Naming Server 情報の取得

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

引数:
self 
戻り値:
Naming Server リスト

RTObject.py2107 行で定義されています。

def setObjRef (   self,
  rtobj 
)

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

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

引数:
self 
rtobj オブジェクトリファレンス

RTObject.py2124 行で定義されています。

def getObjRef (   self  ) 

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

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

引数:
self 
戻り値:
オブジェクトリファレンス

RTObject.py2143 行で定義されています。

def setProperties (   self,
  prop 
)

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

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

引数:
self 
prop RTC のプロパティ

RTObject.py2172 行で定義されています。

def getProperties (   self  ) 

[local interface] RTC のプロパティを取得する

RTC が保持しているプロパティを返す。 RTCがプロパティを持たない場合は空のプロパティが返される。

引数:
self 
戻り値:
RTC のプロパティ

RTObject.py2204 行で定義されています。

def bindParameter (   self,
  param_name,
  var,
  def_val,
  trans = None 
)

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

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

引数:
self 
param_name コンフィギュレーションパラメータ名
var コンフィギュレーションパラメータ格納用変数
def_val コンフィギュレーションパラメータデフォルト値
trans 文字列変換用関数(デフォルト値:None)
戻り値:
設定結果(設定成功:true,設定失敗:false)

RTObject.py2227 行で定義されています。

def updateParameters (   self,
  config_set 
)

コンフィギュレーションパラメータの更新(ID指定)

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

引数:
self 
config_set 設定対象のコンフィギュレーションセットID

RTObject.py2251 行で定義されています。

def registerPort (   self,
  port 
)

[local interface] Port を登録する

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

引数:
self 
port RTC に登録する Port

RTObject.py2287 行で定義されています。

def registerInPort (   self,
  name,
  inport 
)

[local interface] DataInPort を登録する

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

引数:
self 
name port 名称
inport 登録対象 DataInPort

RTObject.py2309 行で定義されています。

def registerOutPort (   self,
  name,
  outport 
)

[local interface] DataOutPort を登録する

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

引数:
self 
name port 名称
outport 登録対象 DataInPort

RTObject.py2332 行で定義されています。

def deletePort (   self,
  port 
)

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

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

引数:
self 
port 削除対象 Port

RTObject.py2357 行で定義されています。

def deletePortByName (   self,
  port_name 
)

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

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

引数:
self 
port_name 削除対象 Port 名

RTObject.py2375 行で定義されています。

def finalizePorts (   self  ) 

全 Port の登録を削除する

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

引数:
self 

RTObject.py2397 行で定義されています。

def shutdown (   self  ) 

RTC を終了する

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

引数:
self 

RTObject.py2416 行で定義されています。


OpenRTMに対してMon Mar 17 15:11:08 2008に生成されました。  doxygen 1.5.4