OpenRTM  1.0.0
クラス | 公開型 | 公開メンバ関数 | 全メンバ一覧
coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor > クラステンプレート

Factory テンプレートクラス [詳解]

#include <Factory.h>

coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor > の継承関係図
coil::GlobalFactory< AbstractClass, Identifier, Compare, Creator, Destructor >

公開型

enum  ReturnCode {
  FACTORY_OK, FACTORY_ERROR, ALREADY_EXISTS, NOT_FOUND,
  INVALID_ARG, UNKNOWN_ERROR
}
 
typedef std::map< Identifier, FactoryEntry > FactoryMap
 
typedef FactoryMap::iterator FactoryMapIt
 

公開メンバ関数

bool hasFactory (const Identifier &id)
 ファクトリー有無チェック [詳解]
 
std::vector< Identifier > getIdentifiers ()
 ファクトリーIDリスト取得 [詳解]
 
ReturnCode addFactory (const Identifier &id, Creator creator, Destructor destructor)
 ファクトリー登録 [詳解]
 
ReturnCode removeFactory (const Identifier &id)
 ファクトリー削除 [詳解]
 
AbstractClass * createObject (const Identifier &id)
 ファクトリーオブジェクト生成 [詳解]
 
void deleteObject (const Identifier &id, AbstractClass *&obj)
 ファクトリーオブジェクト削除 [詳解]
 
void deleteObject (AbstractClass *&obj)
 ファクトリーオブジェクト削除 [詳解]
 

詳解

template<class AbstractClass, typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
class coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >

Factory テンプレートクラス

型定義メンバ詳解

template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
typedef std::map<Identifier, FactoryEntry> coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::FactoryMap
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
typedef FactoryMap::iterator coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::FactoryMapIt

列挙型メンバ詳解

template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
enum coil::Factory::ReturnCode
列挙値
FACTORY_OK 
FACTORY_ERROR 
ALREADY_EXISTS 
NOT_FOUND 
INVALID_ARG 
UNKNOWN_ERROR 

関数詳解

template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
ReturnCode coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::addFactory ( const Identifier &  id,
Creator  creator,
Destructor  destructor 
)
inline

ファクトリー登録

ファクトリーを登録する。

引数
idファクトリーID
creatorクリエータ用ファンクタ
destructorデストラクタ用ファンクタ
戻り値
FACTORY_OK: 正常終了 ALREADY_EXISTS: 登録済み INVALID_ARG: creator か destructor が不正な値を含む
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
AbstractClass* coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::createObject ( const Identifier &  id)
inline

ファクトリーオブジェクト生成

ファクトリーオブジェクトを生成する。

引数
idファクトリーID
戻り値
AbstractClass のポインタ
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
void coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::deleteObject ( const Identifier &  id,
AbstractClass *&  obj 
)
inline

ファクトリーオブジェクト削除

ファクトリーオブジェクトを削除する。

引数
idファクトリーID
objファクトリーオブジェクト
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
void coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::deleteObject ( AbstractClass *&  obj)
inline

ファクトリーオブジェクト削除

ファクトリーオブジェクトを削除する。

引数
objファクトリーオブジェクト
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
std::vector<Identifier> coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::getIdentifiers ( )
inline

ファクトリーIDリスト取得

ファクトリーIDリストを返す。

戻り値
ID リスト
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
bool coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::hasFactory ( const Identifier &  id)
inline

ファクトリー有無チェック

指定IDのファクトリー有無を返す。

引数
idファクトリーID
戻り値
true: 有り, false: 無し
template<class AbstractClass , typename Identifier = std::string, typename Compare = std::less<Identifier>, typename Creator = AbstractClass* (*)(), typename Destructor = void (*)(AbstractClass*&)>
ReturnCode coil::Factory< AbstractClass, Identifier, Compare, Creator, Destructor >::removeFactory ( const Identifier &  id)
inline

ファクトリー削除

ファクトリーを削除する。

引数
idファクトリーID
戻り値
FACTORY_OK: 正常終了 NOT_FOUND: ID未登録