OpenRTM-aist-Python 2.0.2
|
クラス | |
class | ECFactoryPredicate |
class | FactoryPredicate |
class | Finalized |
class | InstanceName |
class | ModulePredicate |
OpenRTM_aist.Manager.Manager.__init__ | ( | self, | |
_manager = None ) |
コピーコンストラクタ
コピーコンストラクタ
self | |
_manager | コピー元マネージャオブジェクト(デフォルト値:None) |
OpenRTM_aist.Manager.Manager.activateManager | ( | self | ) |
Managerのアクティブ化
このオペレーションは以下の処理を行う
このオペレーションは、マネージャの初期化後、runManager() の前に呼ぶ必要がある。
self |
OpenRTM_aist.Manager.Manager.addExecutionContext | ( | self, | |
ec ) |
リストに実行コンテキストのインスタンスを追加
Managerが管理するRTCが生成したECはリストに追加する必要がある
self | |
ec | 実行コンテキスト |
OpenRTM_aist.Manager.Manager.addTask | ( | self, | |
fn, | |||
period ) |
周期実行タスクの登録
周期的に実行する関数や関数オブジェクトを Manager のタイマーに登録する。 removePeriodTask() が実行されるまで処理が継続される。本関数に登録する処理 の中で sleep などの長時間ブロッキングは推奨されない。また周期タスクの中で 本関数を呼び出してはならない。
self | |
fn | 周期実行する関数または関数オブジェクト |
period | 周期実行の実行間隔 |
OpenRTM_aist.Manager.Manager.cleanupComponent | ( | self, | |
comp ) |
RTコンポーネントの登録解除
指定したRTコンポーネントのインスタンスをネーミングサービスから 登録解除する。
self | |
comp | 登録解除対象RTコンポーネント |
OpenRTM_aist.Manager.Manager.cleanupComponents | ( | self | ) |
OpenRTM_aist.Manager.Manager.configureComponent | ( | self, | |
comp, | |||
prop ) |
RTコンポーネントのコンフィギュレーション処理
RTコンポーネントの型およびインスタンス毎に記載されたプロパティファイルの 情報を読み込み、コンポーネントに設定する。 また、各コンポーネントの NamingService 登録時の名称を取得し、設定する。
self | |
comp | コンフィギュレーション対象RTコンポーネント |
void configureComponent(RTObject_impl* comp, const coil.Properties& prop);
OpenRTM_aist.Manager.Manager.connectDataPorts | ( | self, | |
port, | |||
target_ports ) |
指定したデータポートを指定したリスト内のデータポート全てと接続する
self | |
port | 対象のデータポート |
target_ports | 接続対象のデータポートのリスト void connectDataPorts(PortService_ptr port,PortServiceList_var& target_ports) |
OpenRTM_aist.Manager.Manager.connectServicePorts | ( | self, | |
port, | |||
target_ports ) |
指定したサービスポートを指定したリスト内のサービスポート全てと接続する
self | |
port | 対象のサービスポート |
target_ports | 接続対象のサービスポートのリスト void connectServicePorts(PortService_ptr port,PortServiceList_var& target_ports) |
OpenRTM_aist.Manager.Manager.createComponent | ( | self, | |
comp_args ) |
RTコンポーネントを生成する
指定したRTコンポーネントのインスタンスを登録されたFactory経由 で生成する。
生成されるコンポーネントの各種プロファイルは以下の優先順位で 設定される。
インスタンス生成が成功した場合、併せて以下の処理を実行する。
comp_args | 生成対象RTコンポーネントIDおよびコンフィギュレー ション引数。フォーマットは大きく分けて "id" と "configuration" 部分が存在する。 |
comp_args: [id]?[configuration] id は必須、configurationはオプション id: RTC:[vendor]:[category]:[implementation_id]:[version] RTC は固定かつ必須 vendor, category, version はオプション implementation_id は必須 オプションを省略する場合でも ":" は省略不可 configuration: [key0]=[value0]&[key1]=[value1]&[key2]=[value2]..... RTCが持つPropertiesの値をすべて上書きすることができる。 key=value の形式で記述し、"&" で区切る
例えば、 RTC:jp.go.aist:example:ConfigSample:1.0?conf.default.str_param0=munya RTC.example:ConfigSample:?conf.default.int_param0=100
OpenRTM_aist.Manager.Manager.createContext | ( | self, | |
ec_args ) |
Contextを生成する
ExecutionContextBase* createContext(const char* ec_args);
OpenRTM_aist.Manager.Manager.createdExecutionContexts | ( | self | ) |
実行コンテキストをリストを取得する
self |
OpenRTM_aist.Manager.Manager.createORBEndpointOption | ( | self, | |
opt, | |||
endpoints ) |
ORB の Endpoint のコマンドラインオプション作成
opt | コマンドラインオプション |
endpoints | エンドポイントリスト |
void createORBEndpointOption(std.string& opt, coil.vstring& endpoints);
OpenRTM_aist.Manager.Manager.createORBEndpoints | ( | self | ) |
エンドポイントの生成
コンフィグレーションからエンドポイントを生成する。
endpoints | エンドポイントリスト |
void createORBEndpoints(coil.vstring& endpoints);
OpenRTM_aist.Manager.Manager.createORBOptions | ( | self | ) |
ORB のコマンドラインオプション作成
コンフィギュレーション情報に設定された内容から ORB の起動時オプションを作成する。
self |
OpenRTM_aist.Manager.Manager.deleteComponent | ( | self, | |
instance_name = None, | |||
comp = None ) |
Manager に登録されているRTコンポーネントを削除する(未実装)
マネージャに登録されているRTコンポーネントを削除する。
self | |
instance_name | 削除対象RTコンポーネントのインスタンス名 |
OpenRTM_aist.Manager.Manager.endpointPropertySwitch | ( | self | ) |
corba.endpoint_property プロパティの取得
corba.endpoint_property の値を取得しタプルとして返す。ノードのエン ドポイントの内 IPv4, IPv6 のいずれを公開するかを指定するプロパティ corba.endpoint_property を取得し IPv4/IPv6 の有効無効および、有効に するIPアドレスの番号をタプル値として返す。
OpenRTM_aist.Manager.Manager.formatString | ( | self, | |
naming_format, | |||
prop ) |
NamingServer に登録する際の登録情報を組み立てる
指定された書式とプロパティ情報を基に NameServer に登録する際の情報を 組み立てる。 各書式指定用文字の意味は以下のとおり
self | |
naming_format | NamingService 登録情報書式指定 |
prop | 使用するプロパティ情報 |
OpenRTM_aist.Manager.Manager.getComponent | ( | self, | |
instance_name ) |
OpenRTM_aist.Manager.Manager.getComponents | ( | self | ) |
OpenRTM_aist.Manager.Manager.getConfig | ( | self | ) |
マネージャコンフィギュレーションの取得
マネージャに設定したコンフィギュレーションを取得する。
self |
OpenRTM_aist.Manager.Manager.getFactoryProfiles | ( | self | ) |
ファクトリのプロファイルを取得
ファクトリのプロファイルを取得する。
OpenRTM_aist.Manager.Manager.getLoadableModules | ( | self | ) |
ロード可能なモジュールリストを取得する
ロード可能モジュールのリストを取得する。 (現在はModuleManager側で未実装)
self |
OpenRTM_aist.Manager.Manager.getLoadedModules | ( | self | ) |
ロード済みのモジュールリストを取得する
現在マネージャにロードされているモジュールのリストを取得する。
self |
std.vector<coil.Properties> getLoadedModules();
OpenRTM_aist.Manager.Manager.getLogbuf | ( | self, | |
name = "manager" ) |
ログバッファの取得
マネージャに設定したログバッファを取得する。
self |
OpenRTM_aist.Manager.Manager.getManagerServant | ( | self | ) |
OpenRTM_aist.Manager.Manager.getModulesFactories | ( | self | ) |
ファクトリ全リストを取得する
登録されているファクトリの全リストを取得する。
self |
OpenRTM_aist.Manager.Manager.getNaming | ( | self | ) |
OpenRTM_aist.Manager.Manager.getORB | ( | self | ) |
OpenRTM_aist.Manager.Manager.getPOA | ( | self | ) |
OpenRTM_aist.Manager.Manager.getPOAManager | ( | self | ) |
OpenRTM_aist.Manager.Manager.getPortsOnNameServers | ( | self, | |
nsname, | |||
kind ) |
与えられたパス以下の指定されたkindのポートを取得する
self | |
nsname | パス |
kind | kind |
PortServiceList_var getPortsOnNameServers(std.string nsname,std.string kind)
OpenRTM_aist.Manager.Manager.init | ( | * | arg | ) |
マネージャの初期化
マネージャを初期化する static 関数。 マネージャをコマンドライン引数を与えて初期化する。 マネージャを使用する場合は、必ずこの初期化メンバ関数 init() を 呼ばなければならない。 マネージャのインスタンスを取得する方法として、init(), instance() の 2つの static 関数が用意されているが、初期化はinit()でしか行われないため、 Manager の生存期間の一番最初にはinit()を呼ぶ必要がある。
※マネージャの初期化処理
argv | コマンドライン引数 |
OpenRTM_aist.Manager.Manager.initComposite | ( | self | ) |
PeriodicECSharedComposite の初期化
OpenRTM_aist.Manager.Manager.initCpuAffinity | ( | self | ) |
CPUアフィニティの設定
manager.cpu_affinityで指定したプロセスのCPUアフィニティに設定する
self |
OpenRTM_aist.Manager.Manager.initExecContext | ( | self | ) |
ExecutionContextManager の初期化
使用する各 ExecutionContext の初期化処理を実行し、各 ExecutionContext 生成用 Factory を ExecutionContextManager に登録する。
self |
OpenRTM_aist.Manager.Manager.initFactories | ( | self | ) |
ファクトリの初期化
バッファ、スレッド、パブリッシャ、プロバイダ、コンシューマの ファクトリを初期化する。
OpenRTM_aist.Manager.Manager.initLogger | ( | self | ) |
System logger の初期化
System logger の初期化を実行する。 コンフィギュレーションファイルに設定された情報に基づき、 ロガーの初期化,設定を実行する。
self |
OpenRTM_aist.Manager.Manager.initLogstreamFile | ( | self | ) |
self |
OpenRTM_aist.Manager.Manager.initLogstreamOthers | ( | self | ) |
self |
OpenRTM_aist.Manager.Manager.initLogstreamPlugins | ( | self | ) |
self |
OpenRTM_aist.Manager.Manager.initManager | ( | self, | |
argv ) |
OpenRTM_aist.Manager.Manager.initManagerServant | ( | self | ) |
ManagerServant の初期化
OpenRTM_aist.Manager.Manager.initNaming | ( | self | ) |
NamingManager の初期化
NamingManager の初期化処理を実行する。 ただし、 NamingManager を使用しないようにプロパティ情報に設定されている 場合には何もしない。 NamingManager を使用する場合、プロパティ情報に設定されている デフォルト NamingServer を登録する。 また、定期的に情報を更新するように設定されている場合には、指定された周期 で自動更新を行うためのタイマを起動するとともに、更新用メソッドをタイマに 登録する。
self |
OpenRTM_aist.Manager.Manager.initORB | ( | self | ) |
CORBA ORB の初期化処理
設定情報を元にORBを初期化する。
self |
OpenRTM_aist.Manager.Manager.initPreActivation | ( | self | ) |
起動時にrtc.confで指定したRTCをアクティベーションする 例: manager.components.preactivation: RTC1,RTC2~
self | void initPreActivation() |
OpenRTM_aist.Manager.Manager.initPreConnection | ( | self | ) |
起動時にrtc.confで指定したポートを接続する 例: manager.components.preconnect: RTC0.port0?port=RTC0.port1&interface_type=corba_cdr&dataflow_type=pull&~,~
self | void initPreConnection() |
OpenRTM_aist.Manager.Manager.initPreCreation | ( | self | ) |
起動時にrtc.confで指定したRTCを生成する 例: manager.components.precreate RTC1,RTC2~
self | void initPreCreation() |
OpenRTM_aist.Manager.Manager.initTimer | ( | self | ) |
Timer の初期化
使用する各 Timer の初期化処理を実行する。 (現状の実装では何もしない)
self |
OpenRTM_aist.Manager.Manager.instance | ( | ) |
マネージャのインスタンスの取得
マネージャのインスタンスを取得する static 関数。 この関数を呼ぶ前に、必ずこの初期化関数 init() が呼ばれている必要がある。
OpenRTM_aist.Manager.Manager.invoke | ( | self, | |
fn, | |||
delay ) |
Manger のメインスレッドで処理を実行
Manger のメインスレッドで指定された処理を実行する。長時間のブロッ キングを行う関数の登録は推奨しない。
self | |
fn | 関数または関数オブジェクト |
delay | 起動するまでの遅延時間 |
OpenRTM_aist.Manager.Manager.invokeInitProc | ( | self | ) |
void invokeInitProc()
OpenRTM_aist.Manager.Manager.join | ( | self | ) |
マネージャ終了処理の待ち合わせ
self |
OpenRTM_aist.Manager.Manager.load | ( | self, | |
fname, | |||
initfunc ) |
[CORBA interface] モジュールのロード
指定したコンポーネントのモジュールをロードするとともに、 指定した初期化関数を実行する。
self | |
fname | モジュールファイル名 |
initfunc | 初期化関数名 |
OpenRTM_aist.Manager.Manager.main | ( | self | ) |
メインスレッドのメイン関数
self |
OpenRTM_aist.Manager.Manager.mergeProperty | ( | self, | |
prop, | |||
file_name ) |
プロパティ情報のマージ
指定されたファイル内に設定されているプロパティ情報をロードし、 既存の設定済みプロパティとマージする。
self | |
prop | マージ対象プロパティ |
file_name | プロパティ情報が記述されているファイル名 |
OpenRTM_aist.Manager.Manager.notifyFinalized | ( | self, | |
comp ) |
RTコンポーネントの削除する
削除するRTコンポーネントを登録する。 登録されたRTコンポーネントは cleanupComponents() で削除される。
削除するRTコンポーネント |
void notifyFinalized(RTObject_impl* comp);
OpenRTM_aist.Manager.Manager.procComponentArgs | ( | self, | |
comp_arg, | |||
comp_id, | |||
comp_conf ) |
createComponentの引数を処理する @ param self @ param comp_arg(str) @ param comp_id(Properties object) @ param comp_conf(Properties object) @ return True or False
bool procComponentArgs(const char* comp_arg, coil.Properties& comp_id, coil.Properties& comp_conf)
OpenRTM_aist.Manager.Manager.publishPorts | ( | self, | |
comp ) |
指定したRTコンポーネントの保持するポートをNamingServiceにバインドする ポートのpublish_topicというプロパティでトピック名を設定し、トピック名のコンテキストの下に登録
self | |
comp | RTコンポーネント |
void publishPorts(RTObject_impl* comp)
OpenRTM_aist.Manager.Manager.registerComponent | ( | self, | |
comp ) |
RTコンポーネントを直接 Manager に登録する
指定したRTコンポーネントのインスタンスをファクトリ経由ではなく 直接マネージャに登録する。
self | |
comp | 登録対象RTコンポーネントのインスタンス |
OpenRTM_aist.Manager.Manager.registerECFactory | ( | self, | |
name, | |||
new_func, | |||
delete_func ) |
ExecutionContext用ファクトリを登録する
ExecutionContextのインスタンスを生成するためのFactoryを登録する。
self | |
name | 生成対象ExecutionContext名称 |
new_func | ExecutionContext生成用関数 |
delete_func | ExecutionContext破棄用関数 |
OpenRTM_aist.Manager.Manager.registerFactory | ( | self, | |
profile, | |||
new_func, | |||
delete_func ) |
RTコンポーネント用ファクトリを登録する
RTコンポーネントのインスタンスを生成するための Factoryを登録する。
self | |
profile | RTコンポーネント プロファイル |
new_func | RTコンポーネント生成用関数 |
delete_func | RTコンポーネント破棄用関数 |
OpenRTM_aist.Manager.Manager.removeExecutionContext | ( | self, | |
ec ) |
リストから実行コンテキストを削除
self | |
ec | 実行コンテキスト |
OpenRTM_aist.Manager.Manager.removeTask | ( | self, | |
task ) |
周期実行タスクの削除
タイマーに登録されている周期タスクを削除する。
self | |
id | 削除対象のタスクを示す ID |
OpenRTM_aist.Manager.Manager.runManager | ( | self, | |
no_block = False ) |
Managerの実行
このオペレーションはマネージャのメインループを実行する。 このメインループ内では、CORBA ORBのイベントループ等が 処理される。デフォルトでは、このオペレーションはブロックし、 Manager.destroy() が呼ばれるまで処理を戻さない。 引数 no_block が true に設定されている場合は、内部でイベントループ を処理するスレッドを起動し、ブロックせずに処理を戻す。
self | |
no_block | false: ブロッキングモード, true: ノンブロッキングモード |
OpenRTM_aist.Manager.Manager.setEndpointProperty | ( | self, | |
objref ) |
Endpoint をプロパティに設定
この関数はエンドポイントをプロパティ corba.endpoints に指定する。引 数に与えられたオブジェクトリファレンスから現在のプロセスのエンドポ イント (IPアドレス, ポート番号) を取得し corba.endpoints, corba.endpoints_ipv4, corba.endpoints_ipv6 に指定する。
objref | オブジェクトリファレンス |
OpenRTM_aist.Manager.Manager.setModuleInitProc | ( | self, | |
proc ) |
初期化プロシージャのセット
このオペレーションはユーザが行うモジュール等の初期化プロシージャ を設定する。ここで設定されたプロシージャは、マネージャが初期化され、 アクティブ化された後、適切なタイミングで実行される。
self | |
proc | 初期化プロシージャの関数ポインタ |
OpenRTM_aist.Manager.Manager.shutdown | ( | self | ) |
マネージャ・シャットダウン
マネージャの終了処理を実行する。 ORB、タイマースレッドの終了後、同期を取って終了する。
self |
OpenRTM_aist.Manager.Manager.shutdownComponents | ( | self | ) |
NamingManager に登録されている全コンポーネントの終了処理
NamingManager に登録されているRTコンポーネントおよび ExecutionContext の リストを取得し、全コンポーネントを終了する。
self |
OpenRTM_aist.Manager.Manager.shutdownLogger | ( | self | ) |
System Logger の終了処理(未実装)
System Loggerの終了処理を実行する。 (現在は未実装)
self |
OpenRTM_aist.Manager.Manager.shutdownManager | ( | self | ) |
OpenRTM_aist.Manager.Manager.shutdownManagerServant | ( | self | ) |
Managerサーバントの終了処理(未実装)
Managerサーバントを終了する
self |
OpenRTM_aist.Manager.Manager.shutdownNaming | ( | self | ) |
NamingManager の終了処理
NamingManager を終了する。 登録されている全要素をアンバインドし、終了する。
self |
OpenRTM_aist.Manager.Manager.shutdownOnNoRtcs | ( | self | ) |
OpenRTM_aist.Manager.Manager.shutdownORB | ( | self | ) |
ORB の終了処理
ORB の終了処理を実行する。 実行待ちの処理が存在する場合には、その処理が終了するまで待つ。 実際の終了処理では、POA Managerを非活性化し、 ORB のシャットダウンを実行 する。
self |
OpenRTM_aist.Manager.Manager.shutdownTimer | ( | self | ) |
Timer の終了
使用する各 Timer の終了処理を実行する。
self |
OpenRTM_aist.Manager.Manager.subscribePorts | ( | self, | |
comp ) |
指定したRTコンポーネントの保持するポートを同じトピック名以下の接続可能なポートと接続
self | |
comp | RTコンポーネント |
void subscribePorts(RTObject_impl* comp)
OpenRTM_aist.Manager.Manager.terminate | ( | self | ) |
マネージャ終了処理
マネージャの終了処理を実行する。
self |
OpenRTM_aist.Manager.Manager.unload | ( | self, | |
fname ) |
モジュールのアンロード
モジュールをアンロードする
self | |
fname | モジュールのファイル名 |
OpenRTM_aist.Manager.Manager.unloadAll | ( | self | ) |
全モジュールのアンロード
モジュールをすべてアンロードする
self |
OpenRTM_aist.Manager.Manager.unregisterComponent | ( | self, | |
comp ) |
RTコンポーネントの登録を解除する
指定したRTコンポーネントの登録を解除する。
self | |
comp | 登録解除対象RTコンポーネントのインスタンス |