openrave.org

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
cppexamples::OpenRAVEExample Class Referenceabstract

A simple framework for running C++ examples. More...

#include <orexample.h>

Inheritance diagram for cppexamples::OpenRAVEExample:
Inheritance graph
[legend]

Public Member Functions

 OpenRAVEExample (const std::string &viewername="qtcoin")
 
virtual ~OpenRAVEExample ()
 
virtual int main (int argc, char **argv)
 
virtual bool IsOk ()
 
virtual void Exit ()
 
virtual void demothread (int argc, char **argv)=0
 

Protected Attributes

OpenRAVE::EnvironmentBasePtr penv
 

Detailed Description

A simple framework for running C++ examples.

It makes sure OpenRAVE cleans itself up by registering itself into the sighandler. In order to use, derive from it:

class TrajectoryExample : public OpenRAVEExample
{
public:
virtual void demothread() {
// insert user code here
penv->Load("data/lab1.env.xml");
}
};

Definition at line 31 of file orexample.h.

Constructor & Destructor Documentation

cppexamples::OpenRAVEExample::OpenRAVEExample ( const std::string &  viewername = "qtcoin")
inline

Definition at line 34 of file orexample.h.

virtual cppexamples::OpenRAVEExample::~OpenRAVEExample ( )
inlinevirtual

!_thopenrave ) {

Definition at line 39 of file orexample.h.

Member Function Documentation

virtual void cppexamples::OpenRAVEExample::demothread ( int  argc,
char **  argv 
)
pure virtual
virtual void cppexamples::OpenRAVEExample::Exit ( )
inlinevirtual

Definition at line 80 of file orexample.h.

virtual bool cppexamples::OpenRAVEExample::IsOk ( )
inlinevirtual

Definition at line 76 of file orexample.h.

virtual int cppexamples::OpenRAVEExample::main ( int  argc,
char **  argv 
)
inlinevirtual

Member Data Documentation

OpenRAVE::EnvironmentBasePtr cppexamples::OpenRAVEExample::penv
protected

Definition at line 88 of file orexample.h.


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