OpenRTM-aist-Python 2.0.0
クラス | 公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.Manager.Manager クラス

[詳解]

クラス

class  ECFactoryPredicate
 
class  FactoryPredicate
 
class  Finalized
 
class  InstanceName
 
class  ModulePredicate
 

公開メンバ関数

def __init__ (self, _manager=None)
 
def init (*arg)
 
def instance ()
 
def terminate (self)
 
def shutdown (self)
 
def setModuleInitProc (self, proc)
 
def activateManager (self)
 
def runManager (self, no_block=False)
 
def main (self)
 
def join (self)
 
def load (self, fname, initfunc)
 
def unload (self, fname)
 
def unloadAll (self)
 
def getLoadedModules (self)
 
def getLoadableModules (self)
 
def registerFactory (self, profile, new_func, delete_func)
 
def getFactoryProfiles (self)
 
def registerECFactory (self, name, new_func, delete_func)
 
def getModulesFactories (self)
 
def createComponent (self, comp_args)
 
def registerComponent (self, comp)
 
def unregisterComponent (self, comp)
 
def createContext (self, ec_args)
 
def deleteComponent (self, instance_name=None, comp=None)
 
def getComponent (self, instance_name)
 
def getComponents (self)
 
def getORB (self)
 
def getPOA (self)
 
def getPOAManager (self)
 
def initManager (self, argv)
 
def shutdownManagerServant (self)
 
def shutdownManager (self)
 
def shutdownOnNoRtcs (self)
 
def initLogstreamFile (self)
 
def initLogstreamPlugins (self)
 
def initLogstreamOthers (self)
 
def initLogger (self)
 
def shutdownLogger (self)
 
def initORB (self)
 
def createORBOptions (self)
 
def createORBEndpoints (self)
 
def createORBEndpointOption (self, opt, endpoints)
 
def shutdownORB (self)
 
def initNaming (self)
 
def shutdownNaming (self)
 
def initExecContext (self)
 
def initCpuAffinity (self)
 
def initComposite (self)
 
def initFactories (self)
 
def initTimer (self)
 
def shutdownTimer (self)
 
def endpointPropertySwitch (self)
 
def setEndpointProperty (self, objref)
 
def initManagerServant (self)
 
def shutdownComponents (self)
 
def cleanupComponent (self, comp)
 
def cleanupComponents (self)
 
def notifyFinalized (self, comp)
 
def procComponentArgs (self, comp_arg, comp_id, comp_conf)
 
def configureComponent (self, comp, prop)
 
def mergeProperty (self, prop, file_name)
 
def formatString (self, naming_format, prop)
 
def getLogbuf (self, name="manager")
 
def getConfig (self)
 
def publishPorts (self, comp)
 
def subscribePorts (self, comp)
 
def getPortsOnNameServers (self, nsname, kind)
 
def connectDataPorts (self, port, target_ports)
 
def connectServicePorts (self, port, target_ports)
 
def initPreConnection (self)
 
def initPreActivation (self)
 
def initPreCreation (self)
 
def invokeInitProc (self)
 
def getManagerServant (self)
 
def getNaming (self)
 
def addTask (self, fn, period)
 
def invoke (self, fn, delay)
 
def removeTask (self, task)
 
def addExecutionContext (self, ec)
 
def removeExecutionContext (self, ec)
 
def createdExecutionContexts (self)
 

詳解

Manager クラス

コンポーネントなど各種の情報管理を行うマネージャクラス。

から
0.2.0

構築子と解体子

◆ __init__()

def OpenRTM_aist.Manager.Manager.__init__ (   self,
  _manager = None 
)

コピーコンストラクタ

コピーコンストラクタ

引数
self
_managerコピー元マネージャオブジェクト(デフォルト値:None)

メソッド詳解

◆ activateManager()

def OpenRTM_aist.Manager.Manager.activateManager (   self)

Managerのアクティブ化

このオペレーションは以下の処理を行う

  • CORBA POAManager のアクティブ化
  • マネージャCORBAオブジェクトのアクティブ化
  • Manager オブジェクトへの初期化プロシージャの実行

このオペレーションは、マネージャの初期化後、runManager() の前に呼ぶ必要がある。

引数
self
戻り値
処理結果(アクティブ化成功:true、失敗:false)

◆ addExecutionContext()

def OpenRTM_aist.Manager.Manager.addExecutionContext (   self,
  ec 
)

リストに実行コンテキストのインスタンスを追加

Managerが管理するRTCが生成したECはリストに追加する必要がある

引数
self
ec実行コンテキスト
戻り値
既に追加済みの場合はFalseを返す

◆ addTask()

def OpenRTM_aist.Manager.Manager.addTask (   self,
  fn,
  period 
)

周期実行タスクの登録

周期的に実行する関数や関数オブジェクトを Manager のタイマーに登録する。 removePeriodTask() が実行されるまで処理が継続される。本関数に登録する処理 の中で sleep などの長時間ブロッキングは推奨されない。また周期タスクの中で 本関数を呼び出してはならない。

引数
self
fn周期実行する関数または関数オブジェクト
period周期実行の実行間隔
戻り値
id removeTask() で実行解除するための ID
PeriodicFunction

◆ cleanupComponent()

def OpenRTM_aist.Manager.Manager.cleanupComponent (   self,
  comp 
)

RTコンポーネントの登録解除

指定したRTコンポーネントのインスタンスをネーミングサービスから 登録解除する。

引数
self
comp登録解除対象RTコンポーネント

◆ cleanupComponents()

def OpenRTM_aist.Manager.Manager.cleanupComponents (   self)

RTコンポーネントの削除する

notifyFinalized()によって登録されたRTコンポーネントを削除する。

void cleanupComponents();

◆ configureComponent()

def OpenRTM_aist.Manager.Manager.configureComponent (   self,
  comp,
  prop 
)

RTコンポーネントのコンフィギュレーション処理

RTコンポーネントの型およびインスタンス毎に記載されたプロパティファイルの 情報を読み込み、コンポーネントに設定する。 また、各コンポーネントの NamingService 登録時の名称を取得し、設定する。

引数
self
compコンフィギュレーション対象RTコンポーネント

void configureComponent(RTObject_impl* comp, const coil::Properties& prop);

◆ connectDataPorts()

def OpenRTM_aist.Manager.Manager.connectDataPorts (   self,
  port,
  target_ports 
)

指定したデータポートを指定したリスト内のデータポート全てと接続する

引数
self
port対象のデータポート
target_ports接続対象のデータポートのリスト void connectDataPorts(PortService_ptr port,PortServiceList_var& target_ports)

◆ connectServicePorts()

def OpenRTM_aist.Manager.Manager.connectServicePorts (   self,
  port,
  target_ports 
)

指定したサービスポートを指定したリスト内のサービスポート全てと接続する

引数
self
port対象のサービスポート
target_ports接続対象のサービスポートのリスト void connectServicePorts(PortService_ptr port,PortServiceList_var& target_ports)

◆ createComponent()

def OpenRTM_aist.Manager.Manager.createComponent (   self,
  comp_args 
)

RTコンポーネントを生成する

指定したRTコンポーネントのインスタンスを登録されたFactory経由 で生成する。

生成されるコンポーネントの各種プロファイルは以下の優先順位で 設定される。

  1. createComponent() の引数で与えられたプロファイル
  2. rtc.confで指定された外部ファイルで与えられたプロファイル –# category.instance_name.config_file –# category.component_type.config_file
  3. コードに埋め込まれたプロファイル

インスタンス生成が成功した場合、併せて以下の処理を実行する。

  • 外部ファイルで設定したコンフィギュレーション情報の読み込み,設定
  • ExecutionContextのバインド,動作開始
  • ネーミングサービスへの登録
引数
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

戻り値
生成したRTコンポーネントのインスタンス

◆ createContext()

def OpenRTM_aist.Manager.Manager.createContext (   self,
  ec_args 
)

Contextを生成する

戻り値
生成したConetextのインスタンス

ExecutionContextBase* createContext(const char* ec_args);

◆ createdExecutionContexts()

def OpenRTM_aist.Manager.Manager.createdExecutionContexts (   self)

実行コンテキストをリストを取得する

引数
self
戻り値
実行コンテキストのリスト

◆ createORBEndpointOption()

def OpenRTM_aist.Manager.Manager.createORBEndpointOption (   self,
  opt,
  endpoints 
)

ORB の Endpoint のコマンドラインオプション作成

引数
optコマンドラインオプション
endpointsエンドポイントリスト

void createORBEndpointOption(std::string& opt, coil::vstring& endpoints);

◆ createORBEndpoints()

def OpenRTM_aist.Manager.Manager.createORBEndpoints (   self)

エンドポイントの生成

コンフィグレーションからエンドポイントを生成する。

引数
endpointsエンドポイントリスト

void createORBEndpoints(coil::vstring& endpoints);

◆ createORBOptions()

def OpenRTM_aist.Manager.Manager.createORBOptions (   self)

ORB のコマンドラインオプション作成

コンフィギュレーション情報に設定された内容から ORB の起動時オプションを作成する。

引数
self
戻り値
ORB 起動時オプション

◆ deleteComponent()

def OpenRTM_aist.Manager.Manager.deleteComponent (   self,
  instance_name = None,
  comp = None 
)

Manager に登録されているRTコンポーネントを削除する(未実装)

マネージャに登録されているRTコンポーネントを削除する。

引数
self
instance_name削除対象RTコンポーネントのインスタンス名

◆ endpointPropertySwitch()

def OpenRTM_aist.Manager.Manager.endpointPropertySwitch (   self)

corba.endpoint_property プロパティの取得

corba.endpoint_property の値を取得しタプルとして返す。ノードのエン ドポイントの内 IPv4, IPv6 のいずれを公開するかを指定するプロパティ corba.endpoint_property を取得し IPv4/IPv6 の有効無効および、有効に するIPアドレスの番号をタプル値として返す。

戻り値
(ipv4, ipv4_list, ipv6, ipv6_list) endpoint_property 値 ipv4, ipv6: IPv4/IPv6 の有効無効を示すTrue/False ipv4_list, ipv6_list: 有効にするアドレスの番号、空リストの場合はすべて有効

◆ formatString()

def OpenRTM_aist.Manager.Manager.formatString (   self,
  naming_format,
  prop 
)

NamingServer に登録する際の登録情報を組み立てる

指定された書式とプロパティ情報を基に NameServer に登録する際の情報を 組み立てる。 各書式指定用文字の意味は以下のとおり

  • % : コンテキストの区切り
  • n : インスタンス名称
  • t : 型名
  • m : 型名
  • v : バージョン
  • V : ベンダー
  • c : カテゴリ
  • h : ホスト名
  • M : マネージャ名
  • p : プロセスID
引数
self
naming_formatNamingService 登録情報書式指定
prop使用するプロパティ情報
戻り値
指定書式変換結果

◆ getComponent()

def OpenRTM_aist.Manager.Manager.getComponent (   self,
  instance_name 
)

Manager に登録されているRTコンポーネントを検索する

Manager に登録されているRTコンポーネントを指定した名称で検索し、 合致するコンポーネントを取得する。

引数
self
instance_name検索対象RTコンポーネントの名称
戻り値
名称が一致するRTコンポーネントのインスタンス

◆ getComponents()

def OpenRTM_aist.Manager.Manager.getComponents (   self)

Manager に登録されている全RTコンポーネントを取得する

Manager に登録されているRTコンポーネントの全インスタンスを取得する。

引数
self
戻り値
全RTコンポーネントのインスタンスリスト

◆ getConfig()

def OpenRTM_aist.Manager.Manager.getConfig (   self)

マネージャコンフィギュレーションの取得

マネージャに設定したコンフィギュレーションを取得する。

引数
self
戻り値
マネージャのコンフィギュレーション

◆ getFactoryProfiles()

def OpenRTM_aist.Manager.Manager.getFactoryProfiles (   self)

ファクトリのプロファイルを取得

ファクトリのプロファイルを取得する。

戻り値
ファクトリのプロファイル

◆ getLoadableModules()

def OpenRTM_aist.Manager.Manager.getLoadableModules (   self)

ロード可能なモジュールリストを取得する

ロード可能モジュールのリストを取得する。 (現在はModuleManager側で未実装)

引数
self
戻り値
ロード可能モジュール リスト

◆ getLoadedModules()

def OpenRTM_aist.Manager.Manager.getLoadedModules (   self)

ロード済みのモジュールリストを取得する

現在マネージャにロードされているモジュールのリストを取得する。

引数
self
戻り値
ロード済みモジュールリスト

std::vector<coil::Properties> getLoadedModules();

◆ getLogbuf()

def OpenRTM_aist.Manager.Manager.getLogbuf (   self,
  name = "manager" 
)

ログバッファの取得

マネージャに設定したログバッファを取得する。

引数
self
戻り値
マネージャに設定したログバッファ

◆ getManagerServant()

def OpenRTM_aist.Manager.Manager.getManagerServant (   self)

ManagerServantを取得する

引数
self
戻り値
ManagerServant ManagerServant* getManagerServant()

◆ getModulesFactories()

def OpenRTM_aist.Manager.Manager.getModulesFactories (   self)

ファクトリ全リストを取得する

登録されているファクトリの全リストを取得する。

引数
self
戻り値
登録ファクトリ リスト

◆ getNaming()

def OpenRTM_aist.Manager.Manager.getNaming (   self)

NamingManagerを取得する

引数
self
戻り値
NamingManager NamingManager* getNaming()

◆ getORB()

def OpenRTM_aist.Manager.Manager.getORB (   self)

ORB のポインタを取得する

Manager に設定された ORB のポインタを取得する。

引数
self
戻り値
ORB オブジェクト

◆ getPOA()

def OpenRTM_aist.Manager.Manager.getPOA (   self)

Manager が持つ RootPOA のポインタを取得する

Manager に設定された RootPOA へのポインタを取得する。

引数
self
戻り値
RootPOAオブジェクト

◆ getPOAManager()

def OpenRTM_aist.Manager.Manager.getPOAManager (   self)

Manager が持つ POAManager を取得する

Manager に設定された POAMAnager を取得する。

引数
self
戻り値
POAマネージャ

◆ getPortsOnNameServers()

def OpenRTM_aist.Manager.Manager.getPortsOnNameServers (   self,
  nsname,
  kind 
)

与えられたパス以下の指定されたkindのポートを取得する

引数
self
nsnameパス
kindkind
戻り値
ポートのオブジェクトリファレンスのリスト

PortServiceList_var getPortsOnNameServers(std::string nsname,std::string kind)

◆ init()

def OpenRTM_aist.Manager.Manager.init ( arg)

マネージャの初期化

マネージャを初期化する static 関数。 マネージャをコマンドライン引数を与えて初期化する。 マネージャを使用する場合は、必ずこの初期化メンバ関数 init() を 呼ばなければならない。 マネージャのインスタンスを取得する方法として、init(), instance() の 2つの static 関数が用意されているが、初期化はinit()でしか行われないため、 Manager の生存期間の一番最初にはinit()を呼ぶ必要がある。

※マネージャの初期化処理

  • initManager: 引数処理、configファイルの読み込み、サブシステム初期化
  • initLogger: Logger初期化
  • initORB: ORB 初期化
  • initNaming: NamingService 初期化
  • initExecutionContext: ExecutionContext factory 初期化
  • initTimer: Timer 初期化
引数
argvコマンドライン引数
戻り値
Manager の唯一のインスタンスの参照

◆ initComposite()

def OpenRTM_aist.Manager.Manager.initComposite (   self)

PeriodicECSharedComposite の初期化

戻り値
PeriodicECSharedComposite 初期化処理実行結果 (初期化成功:true、初期化失敗:false)

◆ initCpuAffinity()

def OpenRTM_aist.Manager.Manager.initCpuAffinity (   self)

CPUアフィニティの設定

manager.cpu_affinityで指定したプロセスのCPUアフィニティに設定する

引数
self

◆ initExecContext()

def OpenRTM_aist.Manager.Manager.initExecContext (   self)

ExecutionContextManager の初期化

使用する各 ExecutionContext の初期化処理を実行し、各 ExecutionContext 生成用 Factory を ExecutionContextManager に登録する。

引数
self
戻り値
ExecutionContextManager 初期化処理実行結果 (初期化成功:true、初期化失敗:false)

◆ initFactories()

def OpenRTM_aist.Manager.Manager.initFactories (   self)

ファクトリの初期化

バッファ、スレッド、パブリッシャ、プロバイダ、コンシューマの ファクトリを初期化する。

戻り値
ファクトリ初期化処理実行結果 (初期化成功:true、初期化失敗:false)

◆ initLogger()

def OpenRTM_aist.Manager.Manager.initLogger (   self)

System logger の初期化

System logger の初期化を実行する。 コンフィギュレーションファイルに設定された情報に基づき、 ロガーの初期化,設定を実行する。

引数
self
戻り値
初期化実行結果(初期化成功:true、初期化失敗:false)

◆ initLogstreamFile()

def OpenRTM_aist.Manager.Manager.initLogstreamFile (   self)

引数
self

◆ initLogstreamOthers()

def OpenRTM_aist.Manager.Manager.initLogstreamOthers (   self)

引数
self

◆ initLogstreamPlugins()

def OpenRTM_aist.Manager.Manager.initLogstreamPlugins (   self)

引数
self

◆ initManager()

def OpenRTM_aist.Manager.Manager.initManager (   self,
  argv 
)

Manager の内部初期化処理

Manager の内部初期化処理を実行する。

  • Manager コンフィギュレーションの設定
  • ログ出力ファイルの設定
  • 終了処理用スレッドの生成
  • タイマ用スレッドの生成(タイマ使用時)
引数
self
argvコマンドライン引数

◆ initManagerServant()

def OpenRTM_aist.Manager.Manager.initManagerServant (   self)

ManagerServant の初期化

戻り値
Timer 初期化処理実行結果(初期化成功:true、初期化失敗:false)

◆ initNaming()

def OpenRTM_aist.Manager.Manager.initNaming (   self)

NamingManager の初期化

NamingManager の初期化処理を実行する。 ただし、 NamingManager を使用しないようにプロパティ情報に設定されている 場合には何もしない。 NamingManager を使用する場合、プロパティ情報に設定されている デフォルト NamingServer を登録する。 また、定期的に情報を更新するように設定されている場合には、指定された周期 で自動更新を行うためのタイマを起動するとともに、更新用メソッドをタイマに 登録する。

引数
self
戻り値
初期化処理結果(初期化成功:true、初期化失敗:false)

◆ initORB()

def OpenRTM_aist.Manager.Manager.initORB (   self)

CORBA ORB の初期化処理

設定情報を元にORBを初期化する。

引数
self
戻り値
ORB 初期化処理結果(初期化成功:true、初期化失敗:false)

◆ initPreActivation()

def OpenRTM_aist.Manager.Manager.initPreActivation (   self)

起動時にrtc.confで指定したRTCをアクティベーションする 例: manager.components.preactivation: RTC1,RTC2~

引数
selfvoid initPreActivation()

◆ initPreConnection()

def OpenRTM_aist.Manager.Manager.initPreConnection (   self)

起動時にrtc.confで指定したポートを接続する 例: manager.components.preconnect: RTC0.port0?port=RTC0.port1&interface_type=corba_cdr&dataflow_type=pull&~,~

引数
selfvoid initPreConnection()

◆ initPreCreation()

def OpenRTM_aist.Manager.Manager.initPreCreation (   self)

起動時にrtc.confで指定したRTCを生成する 例: manager.components.precreate RTC1,RTC2~

引数
selfvoid initPreCreation()

◆ initTimer()

def OpenRTM_aist.Manager.Manager.initTimer (   self)

Timer の初期化

使用する各 Timer の初期化処理を実行する。 (現状の実装では何もしない)

引数
self
戻り値
Timer 初期化処理実行結果(初期化成功:true、初期化失敗:false)

◆ instance()

def OpenRTM_aist.Manager.Manager.instance ( )

マネージャのインスタンスの取得

マネージャのインスタンスを取得する static 関数。 この関数を呼ぶ前に、必ずこの初期化関数 init() が呼ばれている必要がある。

戻り値
Manager の唯一のインスタンスの参照

◆ invoke()

def OpenRTM_aist.Manager.Manager.invoke (   self,
  fn,
  delay 
)

Manger のメインスレッドで処理を実行

Manger のメインスレッドで指定された処理を実行する。長時間のブロッ キングを行う関数の登録は推奨しない。

引数
self
fn関数または関数オブジェクト
delay起動するまでの遅延時間
戻り値
DelayedFunction

◆ invokeInitProc()

def OpenRTM_aist.Manager.Manager.invokeInitProc (   self)

◆ join()

def OpenRTM_aist.Manager.Manager.join (   self)

マネージャ終了処理の待ち合わせ

引数
self

◆ load()

def OpenRTM_aist.Manager.Manager.load (   self,
  fname,
  initfunc 
)

[CORBA interface] モジュールのロード

指定したコンポーネントのモジュールをロードするとともに、 指定した初期化関数を実行する。

引数
self
fnameモジュールファイル名
initfunc初期化関数名
戻り値
エラーコード RTC::RTC_OK 正常終了 RTC::RTC_ERROR ロード失敗・不明なエラー RTC::PRECONDITION_NOT_MET 設定により許可されない操作 RTC::BAD_PARAMETER 不正なパラメータ

◆ main()

def OpenRTM_aist.Manager.Manager.main (   self)

メインスレッドのメイン関数

引数
self

◆ mergeProperty()

def OpenRTM_aist.Manager.Manager.mergeProperty (   self,
  prop,
  file_name 
)

プロパティ情報のマージ

指定されたファイル内に設定されているプロパティ情報をロードし、 既存の設定済みプロパティとマージする。

引数
self
propマージ対象プロパティ
file_nameプロパティ情報が記述されているファイル名
戻り値
マージ処理実行結果(マージ成功:true、マージ失敗:false)

◆ notifyFinalized()

def OpenRTM_aist.Manager.Manager.notifyFinalized (   self,
  comp 
)

RTコンポーネントの削除する

削除するRTコンポーネントを登録する。 登録されたRTコンポーネントは cleanupComponents() で削除される。

引数
削除するRTコンポーネント

void notifyFinalized(RTObject_impl* comp);

◆ procComponentArgs()

def 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)

◆ publishPorts()

def OpenRTM_aist.Manager.Manager.publishPorts (   self,
  comp 
)

指定したRTコンポーネントの保持するポートをNamingServiceにバインドする ポートのpublish_topicというプロパティでトピック名を設定し、トピック名のコンテキストの下に登録

引数
self
compRTコンポーネント

void publishPorts(RTObject_impl* comp)

◆ registerComponent()

def OpenRTM_aist.Manager.Manager.registerComponent (   self,
  comp 
)

RTコンポーネントを直接 Manager に登録する

指定したRTコンポーネントのインスタンスをファクトリ経由ではなく 直接マネージャに登録する。

引数
self
comp登録対象RTコンポーネントのインスタンス
戻り値
登録処理結果(登録成功:true、失敗:false)

◆ registerECFactory()

def OpenRTM_aist.Manager.Manager.registerECFactory (   self,
  name,
  new_func,
  delete_func 
)

ExecutionContext用ファクトリを登録する

ExecutionContextのインスタンスを生成するためのFactoryを登録する。

引数
self
name生成対象ExecutionContext名称
new_funcExecutionContext生成用関数
delete_funcExecutionContext破棄用関数
戻り値
登録処理結果(登録成功:true、失敗:false)

◆ registerFactory()

def OpenRTM_aist.Manager.Manager.registerFactory (   self,
  profile,
  new_func,
  delete_func 
)

RTコンポーネント用ファクトリを登録する

RTコンポーネントのインスタンスを生成するための Factoryを登録する。

引数
self
profileRTコンポーネント プロファイル
new_funcRTコンポーネント生成用関数
delete_funcRTコンポーネント破棄用関数
戻り値
登録処理結果(登録成功:true、失敗:false)

◆ removeExecutionContext()

def OpenRTM_aist.Manager.Manager.removeExecutionContext (   self,
  ec 
)

リストから実行コンテキストを削除

引数
self
ec実行コンテキスト
戻り値
指定のECがリストに存在しない場合はFalseを返す

◆ removeTask()

def OpenRTM_aist.Manager.Manager.removeTask (   self,
  task 
)

周期実行タスクの削除

タイマーに登録されている周期タスクを削除する。

引数
self
id削除対象のタスクを示す ID

◆ runManager()

def OpenRTM_aist.Manager.Manager.runManager (   self,
  no_block = False 
)

Managerの実行

このオペレーションはマネージャのメインループを実行する。 このメインループ内では、CORBA ORBのイベントループ等が 処理される。デフォルトでは、このオペレーションはブロックし、 Manager::destroy() が呼ばれるまで処理を戻さない。 引数 no_block が true に設定されている場合は、内部でイベントループ を処理するスレッドを起動し、ブロックせずに処理を戻す。

引数
self
no_blockfalse: ブロッキングモード, true: ノンブロッキングモード

◆ setEndpointProperty()

def OpenRTM_aist.Manager.Manager.setEndpointProperty (   self,
  objref 
)

Endpoint をプロパティに設定

この関数はエンドポイントをプロパティ corba.endpoints に指定する。引 数に与えられたオブジェクトリファレンスから現在のプロセスのエンドポ イント (IPアドレス, ポート番号) を取得し corba.endpoints, corba.endpoints_ipv4, corba.endpoints_ipv6 に指定する。

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

◆ setModuleInitProc()

def OpenRTM_aist.Manager.Manager.setModuleInitProc (   self,
  proc 
)

初期化プロシージャのセット

このオペレーションはユーザが行うモジュール等の初期化プロシージャ を設定する。ここで設定されたプロシージャは、マネージャが初期化され、 アクティブ化された後、適切なタイミングで実行される。

引数
self
proc初期化プロシージャの関数ポインタ

◆ shutdown()

def OpenRTM_aist.Manager.Manager.shutdown (   self)

マネージャ・シャットダウン

マネージャの終了処理を実行する。 ORB、タイマースレッドの終了後、同期を取って終了する。

引数
self

◆ shutdownComponents()

def OpenRTM_aist.Manager.Manager.shutdownComponents (   self)

NamingManager に登録されている全コンポーネントの終了処理

NamingManager に登録されているRTコンポーネントおよび ExecutionContext の リストを取得し、全コンポーネントを終了する。

引数
self

◆ shutdownLogger()

def OpenRTM_aist.Manager.Manager.shutdownLogger (   self)

System Logger の終了処理(未実装)

System Loggerの終了処理を実行する。 (現在は未実装)

引数
self

◆ shutdownManager()

def OpenRTM_aist.Manager.Manager.shutdownManager (   self)

Manager の終了処理(未実装)

Manager を終了する (ただし,現在は未実装)

引数
self

◆ shutdownManagerServant()

def OpenRTM_aist.Manager.Manager.shutdownManagerServant (   self)

Managerサーバントの終了処理(未実装)

Managerサーバントを終了する

引数
self

◆ shutdownNaming()

def OpenRTM_aist.Manager.Manager.shutdownNaming (   self)

NamingManager の終了処理

NamingManager を終了する。 登録されている全要素をアンバインドし、終了する。

引数
self

◆ shutdownOnNoRtcs()

def OpenRTM_aist.Manager.Manager.shutdownOnNoRtcs (   self)

Manager の終了処理

configuration の "manager.shutdown_on_nortcs" YES で、 コンポーネントが登録されていない場合 Manager を終了する。

void shutdownOnNoRtcs();

◆ shutdownORB()

def OpenRTM_aist.Manager.Manager.shutdownORB (   self)

ORB の終了処理

ORB の終了処理を実行する。 実行待ちの処理が存在する場合には、その処理が終了するまで待つ。 実際の終了処理では、POA Managerを非活性化し、 ORB のシャットダウンを実行 する。

引数
self

◆ shutdownTimer()

def OpenRTM_aist.Manager.Manager.shutdownTimer (   self)

Timer の終了

使用する各 Timer の終了処理を実行する。

引数
self

◆ subscribePorts()

def OpenRTM_aist.Manager.Manager.subscribePorts (   self,
  comp 
)

指定したRTコンポーネントの保持するポートを同じトピック名以下の接続可能なポートと接続

引数
self
compRTコンポーネント

void subscribePorts(RTObject_impl* comp)

◆ terminate()

def OpenRTM_aist.Manager.Manager.terminate (   self)

マネージャ終了処理

マネージャの終了処理を実行する。

引数
self

◆ unload()

def OpenRTM_aist.Manager.Manager.unload (   self,
  fname 
)

モジュールのアンロード

モジュールをアンロードする

引数
self
fnameモジュールのファイル名

◆ unloadAll()

def OpenRTM_aist.Manager.Manager.unloadAll (   self)

全モジュールのアンロード

モジュールをすべてアンロードする

引数
self

◆ unregisterComponent()

def OpenRTM_aist.Manager.Manager.unregisterComponent (   self,
  comp 
)

RTコンポーネントの登録を解除する

指定したRTコンポーネントの登録を解除する。

引数
self
comp登録解除対象RTコンポーネントのインスタンス
戻り値
登録解除処理結果(解除成功:true、解除失敗:false)

このクラス詳解は次のファイルから抽出されました: