All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
gazebo::PluginT< T > Class Template Reference

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

#include <common/common.hh>

Public Types

typedef T * TPtr
 plugin pointer type definition
 

Public Member Functions

std::string GetFilename () const
 Get the name of the handler.
 
std::string GetHandle () const
 Get the short name of the handler.
 
PluginType GetType () const
 Returns the type of the plugin.
 

Static Public Member Functions

static TPtr Create (const std::string &_filename, const std::string &_handle)
 a class method that creates a plugin from a file name.
 

Protected Attributes

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

Detailed Description

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

A class which all plugins must inherit from.

Member Typedef Documentation

template<class T>
typedef T* gazebo::PluginT< T >::TPtr

plugin pointer type definition

Member Function Documentation

template<class T>
static TPtr gazebo::PluginT< T >::Create ( const std::string &  _filename,
const std::string &  _handle 
)
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]_handleshort name of the handler
Returns
Shared Pointer to this class type
template<class T>
std::string gazebo::PluginT< T >::GetFilename ( ) const
inline

Get the name of the handler.

template<class T>
std::string gazebo::PluginT< T >::GetHandle ( ) const
inline

Get the short name of the handler.

template<class T>
PluginType gazebo::PluginT< T >::GetType ( ) const
inline

Returns the type of the plugin.

Returns
type of the plugin

Member Data Documentation

template<class T>
std::string gazebo::PluginT< T >::filename
protected
template<class T>
std::string gazebo::PluginT< T >::handle
protected
template<class T>
PluginType gazebo::PluginT< T >::type
protected

Type of plugin.

Referenced by gazebo::PluginT< ModelPlugin >::GetType().


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