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

[詳解]

クラス

class  DLL
 
class  DLLEntity
 
class  DLLPred
 
class  Error
 
class  FileNotFound
 
class  InvalidArguments
 
class  InvalidOperation
 
class  ModuleNotFound
 
class  NotAllowedOperation
 
class  NotFound
 
class  SymbolNotFound
 

公開メンバ関数

 __init__ (self, prop)
 
 __del__ (self)
 
 load (self, file_name, init_func=None)
 
 unload (self, file_name)
 
 unloadAll (self)
 
 symbol (self, file_name, func_name)
 
 setLoadpath (self, load_path_list)
 
 getLoadPath (self)
 
 addLoadpath (self, load_path)
 
 getLoadedModules (self)
 
 getModuleList (self, lang, modules)
 
 addNewFile (self, fpath, modules, lang)
 
 getModuleProfiles (self, lang, modules, modprops)
 
 removeInvalidModules (self)
 
 deleteSamePath (self, paths)
 
 getLoadableModules (self)
 
 allowAbsolutePath (self)
 
 disallowAbsolutePath (self)
 
 allowModuleDownload (self)
 
 disallowModuleDownload (self)
 
 findFile (self, fname, load_path)
 
 fileExist (self, filename)
 
 getInitFuncName (self, file_path)
 

詳解

モジュールマネージャクラス


モジュールのロード、アンロードなどを管理するクラス


から
0.4.0


構築子と解体子



◆ __init__()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.__init__ 
          (
                    self, 
        

        

          
          
                    prop )
        

      







コンストラクタ


コンストラクタ。 設定された Property オブジェクト内の情報を基に初期化を実行する。


引数

  

    
self

    
prop初期化用プロパティ

  

  










◆ __del__()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.__del__ 
          (
                    self)
          
        

      







デストラクタ(未実装)


引数

  

    
self

  

  









メソッド詳解



◆ addLoadpath()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.addLoadpath 
          (
                    self, 
        

        

          
          
                    load_path )
        

      







モジュールロードパスを追加する


指定されたパスリストを検索対象パスリストに追加する。


引数

  

    
self

    
load_path追加モジュール検索対象パスリスト

  

  










◆ addNewFile()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.addNewFile 
          (
                    self, 
        

        

          
          
                    fpath, 
        

        

          
          
                    modules, 
        

        

          
          
                    lang )
        

      







キャッシュに無いパスだけmodulesに追加する


引数

  

    
self

    
fpath

    
modules

  

  










◆ allowAbsolutePath()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.allowAbsolutePath 
          (
                    self)
          
        

      







モジュールの絶対パス指定許可


ロード対象モジュールの絶対パス指定を許可するように設定する。


引数

  

    
self

  

  










◆ allowModuleDownload()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.allowModuleDownload 
          (
                    self)
          
        

      







モジュールのURL指定許可


ロード対象モジュールのURL指定を許可する。 本設定が許可されている場合、モジュールをダウンロードしてロードすることが 許可される。


引数

  

    
self

  

  










◆ deleteSamePath()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.deleteSamePath 
          (
                    self, 
        

        

          
          
                    paths )
        

      







同じパスを削除


引数

  

    
self

    
paths

  

  










◆ disallowAbsolutePath()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.disallowAbsolutePath 
          (
                    self)
          
        

      







モジュールの絶対パス指定禁止


ロード対象モジュールの絶対パス指定を禁止するように設定する。


引数

  

    
self

  

  










◆ disallowModuleDownload()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.disallowModuleDownload 
          (
                    self)
          
        

      







モジュールのURL指定禁止


ロード対象モジュールのURL指定を禁止する。


引数

  

    
self

  

  










◆ fileExist()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.fileExist 
          (
                    self, 
        

        

          
          
                    filename )
        

      







ファイルが存在するかどうかのチェック


指定されたファイルが存在するか確認する。


引数

  

    
self

    
filename存在確認対象ファイル名

  

  




戻り値
ファイル存在確認結果(ファイルあり:true，なし:false)








◆ findFile()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.findFile 
          (
                    self, 
        

        

          
          
                    fname, 
        

        

          
          
                    load_path )
        

      







LoadPath からのファイルの検索


指定されたパス内に、指定されたファイルが存在するか確認する。


引数

  

    
self

    
fname検索対象ファイル名 

    
load_path検索先パスリスト

  

  




戻り値
検索されたファイル名








◆ getInitFuncName()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.getInitFuncName 
          (
                    self, 
        

        

          
          
                    file_path )
        

      







初期化関数シンボルを生成する


初期化関数の名称を組み立てる。


引数

  

    
self

    
file_path初期化対象モジュール名称

  

  




戻り値
初期化関数名称組み立て結果








◆ getLoadableModules()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.getLoadableModules 
          (
                    self)
          
        

      







ロード可能モジュールリストを取得する(未実装)


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


引数

  

    
self

  

  




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








◆ getLoadedModules()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.getLoadedModules 
          (
                    self)
          
        

      







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


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


引数

  

    
self

  

  




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


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








◆ getLoadPath()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.getLoadPath 
          (
                    self)
          
        

      







モジュールロードパスを取得する


設定されているモジュールを検索対象パスリストを取得する。


引数

  

    
self

  

  




戻り値
load_path モジュール検索対象パスリスト








◆ getModuleList()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.getModuleList 
          (
                    self, 
        

        

          
          
                    lang, 
        

        

          
          
                    modules )
        

      







指定言語におけるロードパス上のローダブルなファイルリストを返す


引数

  

    
self

    
lang

    
modules

  

  










◆ getModuleProfiles()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.getModuleProfiles 
          (
                    self, 
        

        

          
          
                    lang, 
        

        

          
          
                    modules, 
        

        

          
          
                    modprops )
        

      







指定言語、ファイルリストからモジュールのプロパティを返す


引数

  

    
self

    
lang

    
modules

    
modprops

  

  










◆ load()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.load 
          (
                    self, 
        

        

          
          
                    file_name, 
        

        

          
          
                    init_func = None )
        

      







モジュールのロード、初期化


指定したファイルを共有ライブラリとしてロードするとともに、 指定した初期化用オペレーションを実行する。


引数

  

    
self

    
file_nameロード対象モジュール名 (.pyを除いたファイル名) 

    
init_func初期化処理用オペレーション(デフォルト値:None)

  

  




戻り値
指定したロード対象モジュール名


std.string ModuleManager.load(const std.string& file_name,
                                 const std.string& init_func) 








◆ removeInvalidModules()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.removeInvalidModules 
          (
                    self)
          
        

      







無効なモジュールプロファイルを削除する


引数

  

    
self

  

  










◆ setLoadpath()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.setLoadpath 
          (
                    self, 
        

        

          
          
                    load_path_list )
        

      







モジュールロードパスを指定する


モジュールロード時に対象モジュールを検索するパスを指定する。


引数

  

    
self

    
load_path_listモジュール検索対象パスリスト

  

  










◆ symbol()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.symbol 
          (
                    self, 
        

        

          
          
                    file_name, 
        

        

          
          
                    func_name )
        

      







モジュールのシンボルの参照


モジュールのシンボルを取得する


引数

  

    
self

    
file_name取得対象ファイル名 

    
func_name取得対象関数名

  

  










◆ unload()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.unload 
          (
                    self, 
        

        

          
          
                    file_name )
        

      







モジュールのアンロード


指定したロード済みモジュールをクローズし、アンロードする。


引数

  

    
self

    
file_nameアンロード対象モジュール名

  

  










◆ unloadAll()






      

        

          OpenRTM_aist.ModuleManager.ModuleManager.unloadAll 
          (
                    self)
          
        

      







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


全てのロード済みモジュールをアンロードする。


引数

  

    
self

  

  









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





構築: doxygen 1.11.0