Public Member Functions | List of all members
gazebo::RestWebPlugin Class Reference

REST web plugin. More...

#include <RestWebPlugin.hh>

Inheritance diagram for gazebo::RestWebPlugin:
Inheritance graph
[legend]

Public Member Functions

 RestWebPlugin ()
 Constructor. More...
 
virtual ~RestWebPlugin ()
 Destructor. More...
 
virtual void Load (int _argc, char **_argv)
 Plugin Load. More...
 
void OnEventRestPost (ConstRestPostPtr &_msg)
 Called everytime a REST POST event message is received. More...
 
void OnRestLoginRequest (ConstRestLoginPtr &_msg)
 Called everytime a login message is received. More...
 
void OnRestLogoutRequest (ConstRestLogoutPtr &_msg)
 Called everytime a logout message is received. More...
 
void OnSimEvent (ConstSimEventPtr &_msg)
 Called everytime a SimEvent message is received. More...
 
- Public Member Functions inherited from gazebo::SystemPlugin
 SystemPlugin ()
 Constructor. More...
 
virtual ~SystemPlugin ()
 Destructor. More...
 
virtual void Reset ()
 Override this method for custom plugin reset behavior. More...
 
- Public Member Functions inherited from gazebo::PluginT< SystemPlugin >
 PluginT ()
 Constructor. More...
 
virtual ~PluginT ()
 Destructor. More...
 
std::string GetFilename () const
 Get the name of the handler. More...
 
std::string GetHandle () const
 Get the short name of the handler. More...
 
PluginType GetType () const
 Returns the type of the plugin. More...
 

Additional Inherited Members

- Public Types inherited from gazebo::PluginT< SystemPlugin >
typedef boost::shared_ptr
< SystemPlugin
TPtr
 plugin pointer type definition More...
 
- Static Public Member Functions inherited from gazebo::PluginT< SystemPlugin >
static TPtr Create (const std::string &_filename, const std::string &_name)
 a class method that creates a plugin from a file name. More...
 
- Protected Attributes inherited from gazebo::PluginT< SystemPlugin >
std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Detailed Description

REST web plugin.

Constructor & Destructor Documentation

gazebo::RestWebPlugin::RestWebPlugin ( )

Constructor.

virtual gazebo::RestWebPlugin::~RestWebPlugin ( )
virtual

Destructor.

Member Function Documentation

virtual void gazebo::RestWebPlugin::Load ( int  _argc,
char **  _argv 
)
virtual

Plugin Load.

Parameters
[in]_argcArgument count
[in]_argvArgument vector

Implements gazebo::SystemPlugin.

void gazebo::RestWebPlugin::OnEventRestPost ( ConstRestPostPtr &  _msg)

Called everytime a REST POST event message is received.

Parameters
[in]_msgThe post message
void gazebo::RestWebPlugin::OnRestLoginRequest ( ConstRestLoginPtr &  _msg)

Called everytime a login message is received.

Parameters
[in]_msgThe login message
void gazebo::RestWebPlugin::OnRestLogoutRequest ( ConstRestLogoutPtr &  _msg)

Called everytime a logout message is received.

Parameters
[in]_msgThe login message
void gazebo::RestWebPlugin::OnSimEvent ( ConstSimEventPtr &  _msg)

Called everytime a SimEvent message is received.

Parameters
[in]TheSimEvent message

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