PluginT< T > Class Template Reference

A class which all plugins must inherit from. More...

#include <common/common.hh>

Public Types

typedef boost::shared_ptr< T > TPtr
 plugin pointer type definition More...
 

Public Member Functions

 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...
 

Static Public Member Functions

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

std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Detailed Description

template<class T>
class gazebo::PluginT< T >

A class which all plugins must inherit from.

Member Typedef Documentation

typedef boost::shared_ptr<T> TPtr

plugin pointer type definition

Constructor & Destructor Documentation

PluginT ( )
inline

Constructor.

virtual ~PluginT ( )
inlinevirtual

Destructor.

Member Function Documentation

static TPtr Create ( const std::string &  _filename,
const std::string &  _name 
)
inlinestatic

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

Parameters
[in]_filenamethe path to the shared library.
[in]_nameshort name of the plugin
Returns
Shared Pointer to this class type
std::string GetFilename ( ) const
inline

Get the name of the handler.

std::string GetHandle ( ) const
inline

Get the short name of the handler.

PluginType GetType ( ) const
inline

Returns the type of the plugin.

Returns
type of the plugin

Member Data Documentation

std::string filename
protected

Path to the shared library file.

Referenced by PluginT< ModelPlugin >::Create(), and PluginT< ModelPlugin >::GetFilename().

std::string handleName
protected

Short name.

Referenced by PluginT< ModelPlugin >::GetHandle().


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