openrave.org

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
cppexamples::ConveyorBeltModule Class Reference

Holds a registered set of bodies, at every time step creates new bodies and moves them along a trajectory. More...

Inheritance diagram for cppexamples::ConveyorBeltModule:
Inheritance graph
[legend]
Collaboration diagram for cppexamples::ConveyorBeltModule:
Collaboration graph
[legend]

Public Member Functions

 ConveyorBeltModule (EnvironmentBasePtr penv, std::istream &is)
 
int main (const string &cmd)
 
bool RegisterBody (ostream &sout, istream &sinput)
 
bool SimulationStep (dReal fElapsedTime)
 
- Public Member Functions inherited from OpenRAVE::ModuleBase
 ModuleBase (EnvironmentBasePtr penv)
 
virtual ~ModuleBase ()
 
virtual void Destroy ()
 called when problem gets unloaded from environment
 
virtual void Reset ()
 called when environment is reset
 
- Public Member Functions 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 Member Functions

static InterfaceBasePtr create (EnvironmentBasePtr penv, std::istream &is)
 
- Static Public Member Functions inherited from OpenRAVE::ModuleBase
static InterfaceType GetInterfaceTypeStatic ()
 return the static interface type this class points to (used for safe casting)
 

Additional Inherited Members

- Public Types inherited from OpenRAVE::InterfaceBase
typedef std::map< std::string,
XMLReadablePtr,
CaseInsensitiveCompare
READERSMAP
 
- Protected Types inherited from OpenRAVE::InterfaceBase
typedef boost::function< bool(std::ostream
&, std::istream &)> 
InterfaceCommandFn
 The function to be executed for every command.
 
- Protected Member Functions 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 Attributes inherited from OpenRAVE::InterfaceBase
std::string __description
 

Detailed Description

Holds a registered set of bodies, at every time step creates new bodies and moves them along a trajectory.

Definition at line 23 of file orconveyormovement.cpp.

Constructor & Destructor Documentation

cppexamples::ConveyorBeltModule::ConveyorBeltModule ( EnvironmentBasePtr  penv,
std::istream &  is 
)
inline

Definition at line 38 of file orconveyormovement.cpp.

Member Function Documentation

static InterfaceBasePtr cppexamples::ConveyorBeltModule::create ( EnvironmentBasePtr  penv,
std::istream &  is 
)
inlinestatic

Definition at line 113 of file orconveyormovement.cpp.

int cppexamples::ConveyorBeltModule::main ( const 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

Reimplemented from OpenRAVE::ModuleBase.

Definition at line 47 of file orconveyormovement.cpp.

bool cppexamples::ConveyorBeltModule::RegisterBody ( ostream &  sout,
istream &  sinput 
)
inline

Definition at line 52 of file orconveyormovement.cpp.

bool cppexamples::ConveyorBeltModule::SimulationStep ( dReal  fElapsedTime)
inlinevirtual

Reimplemented from OpenRAVE::ModuleBase.

Definition at line 64 of file orconveyormovement.cpp.


The documentation for this class was generated from the following file: