openrave.org

 全て クラス ネームスペース ファイル 関数 変数 型定義 列挙型 列挙型の値 フレンド マクロ定義 グループ ページ
Public メソッド | Static Public メソッド | すべてのメンバ一覧
クラス OpenRAVE::ModuleBase

[interface] A loadable module of user code meant to solve a specific domain. If not specified, method is not multi-thread safe. See Module Concepts. [詳細]

#include <module.h>

OpenRAVE::ModuleBaseに対する継承グラフ
Inheritance graph
[凡例]
OpenRAVE::ModuleBaseのコラボレーション図
Collaboration graph
[凡例]

Public メソッド

 ModuleBase (EnvironmentBasePtr penv)
 
virtual ~ModuleBase ()
 
virtual int main (const std::string &cmd)
 
virtual void Destroy ()
 called when problem gets unloaded from environment
 
virtual void Reset ()
 called when environment is reset
 
virtual bool SimulationStep (dReal fElapsedTime)
 
- Public メソッド inherited from OpenRAVE::InterfaceBase
 InterfaceBase (InterfaceType type, EnvironmentBasePtr penv)
 
virtual ~InterfaceBase ()
 
InterfaceType GetInterfaceType () const
 
const std::string & GetXMLId () const
 
const std::string & GetPluginName () const
 
EnvironmentBasePtr GetEnv () const
 
const READERSMAPGetReadableInterfaces () const
 Returns the raw map reference, this is not multithread safe and the GetInterfaceMutex should be locked before using.
 
virtual XMLReadablePtr GetReadableInterface (const std::string &xmltag) const
 Returns the readable interface. [multi-thread safe]
 
virtual XMLReadablePtr SetReadableInterface (const std::string &xmltag, XMLReadablePtr readable)
 Set a new readable interface and return the previously set interface if it exists. [multi-thread safe]
 
virtual const std::string & GetDescription () const
 Documentation of the interface in reStructuredText format. See Documenting Interfaces. [multi-thread safe]
 
virtual void SetDescription (const std::string &description)
 sets a description [multi-thread safe]
 
virtual void SetUserData (const std::string &key, UserDataPtr data) const
 set user data for a specific key. [multi-thread safe]
 
virtual UserDataPtr GetUserData (const std::string &key=std::string()) const
 return the user custom data [multi-thread safe]
 
virtual bool RemoveUserData (const std::string &key) const
 removes a user data pointer. if user data pointer does not exist, then return 0, otherwise 1. [multi-thread safe]
 
virtual void SetUserData (UserDataPtr data) RAVE_DEPRECATED
 
virtual const std::string & GetURI () const
 the URI used to load the interface (sometimes this is not possible if the definition lies inside an environment file). [multi-thread safe]
 
virtual const std::string & GetXMLFilename () const
 
virtual void Clone (InterfaceBaseConstPtr preference, int cloningoptions)
 Clone the contents of an interface to the current interface.
 
virtual bool SendCommand (std::ostream &os, std::istream &is)
 Used to send special commands to the interface and receive output.
 
virtual void Serialize (BaseXMLWriterPtr writer, int options=0) const
 serializes the interface
 

Static Public メソッド

static InterfaceType GetInterfaceTypeStatic ()
 return the static interface type this class points to (used for safe casting)
 

Additional Inherited Members

- Public 型 inherited from OpenRAVE::InterfaceBase
typedef std::map< std::string,
XMLReadablePtr,
CaseInsensitiveCompare
READERSMAP
 
- Protected 型 inherited from OpenRAVE::InterfaceBase
typedef boost::function< bool(std::ostream
&, std::istream &)> 
InterfaceCommandFn
 The function to be executed for every command.
 
- Protected メソッド inherited from OpenRAVE::InterfaceBase
virtual void RegisterCommand (const std::string &cmdname, InterfaceCommandFn fncmd, const std::string &strhelp)
 Registers a command and its help string. [multi-thread safe]
 
virtual void UnregisterCommand (const std::string &cmdname)
 Unregisters the command. [multi-thread safe]
 
virtual boost::shared_mutex & GetInterfaceMutex () const
 
- Protected 変数 inherited from OpenRAVE::InterfaceBase
std::string __description
 

説明

[interface] A loadable module of user code meant to solve a specific domain. If not specified, method is not multi-thread safe. See Module Concepts.

例:
orconveyormovement.cpp, orpythonbinding.cpp, と plugincpp.cpp.

module.h30 行で定義されています。

コンストラクタとデストラクタ

OpenRAVE::ModuleBase::ModuleBase ( EnvironmentBasePtr  penv)
inline

module.h33 行で定義されています。

virtual OpenRAVE::ModuleBase::~ModuleBase ( )
inlinevirtual

module.h35 行で定義されています。

関数

virtual void OpenRAVE::ModuleBase::Destroy ( )
inlinevirtual

called when problem gets unloaded from environment

cppexamples::MyModuleで再定義されています。

module.h51 行で定義されています。

static InterfaceType OpenRAVE::ModuleBase::GetInterfaceTypeStatic ( )
inlinestatic

return the static interface type this class points to (used for safe casting)

module.h39 行で定義されています。

virtual int OpenRAVE::ModuleBase::main ( const std::string &  cmd)
inlinevirtual

gets called every time a problem instance is loaded to initialize the problem. Robots might not necessarily be set before this function call returns 0 on success

cppexamples::MyModule, と cppexamples::ConveyorBeltModuleで再定義されています。

module.h46 行で定義されています。

virtual void OpenRAVE::ModuleBase::Reset ( )
inlinevirtual

called when environment is reset

module.h55 行で定義されています。

virtual bool OpenRAVE::ModuleBase::SimulationStep ( dReal  fElapsedTime)
inlinevirtual

cppexamples::PythonBindingModule, と cppexamples::ConveyorBeltModuleで再定義されています。

module.h58 行で定義されています。


このクラスの説明は次のファイルから生成されました: