CameraPlugin Class Reference

#include <CameraPlugin.hh>

Inherits SensorPlugin.

Public Types

typedef boost::shared_ptr< SensorPluginTPtr
 plugin pointer type definition More...
 

Public Member Functions

 CameraPlugin ()
 
virtual ~CameraPlugin ()
 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...
 
virtual void Init ()
 Override this method for custom plugin initialization behavior. More...
 
virtual void Load (sensors::SensorPtr _sensor, sdf::ElementPtr _sdf)
 Load function. More...
 
virtual void OnNewFrame (const unsigned char *_image, unsigned int _width, unsigned int _height, unsigned int _depth, const std::string &_format)
 
virtual void Reset ()
 Override this method for custom plugin reset behavior. 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

rendering::CameraPtr camera
 
unsigned int depth
 
std::string filename
 Path to the shared library file. More...
 
std::string format
 
std::string handleName
 Short name. More...
 
unsigned int height
 
sensors::CameraSensorPtr parentSensor
 
PluginType type
 Type of plugin. More...
 
unsigned int width
 

Member Typedef Documentation

typedef boost::shared_ptr<SensorPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

virtual ~CameraPlugin ( )
virtual

Destructor.

Member Function Documentation

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

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
inlineinherited

Get the name of the handler.

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

Returns
type of the plugin
virtual void Init ( )
inlinevirtualinherited

Override this method for custom plugin initialization behavior.

Reimplemented in PressurePlugin, and FiducialCameraPlugin.

virtual void Load ( sensors::SensorPtr  _sensor,
sdf::ElementPtr  _sdf 
)
virtual

Load function.

Called when a Plugin is first created, and after the World has been loaded. This function should not be blocking.

Parameters
[in]_sensorPointer the Sensor.
[in]_sdfPointer the the SDF element of the plugin.

Implements SensorPlugin.

virtual void OnNewFrame ( const unsigned char *  _image,
unsigned int  _width,
unsigned int  _height,
unsigned int  _depth,
const std::string &  _format 
)
virtual
virtual void Reset ( )
inlinevirtualinherited

Override this method for custom plugin reset behavior.

Member Data Documentation

rendering::CameraPtr camera
protected
unsigned int depth
protected
std::string filename
protectedinherited

Path to the shared library file.

std::string format
protected
std::string handleName
protectedinherited

Short name.

unsigned int height
protected
sensors::CameraSensorPtr parentSensor
protected
PluginType type
protectedinherited

Type of plugin.

unsigned int width
protected

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