gazebo::ArrangePlugin Class Reference

#include <ArrangePlugin.hh>

Inheritance diagram for gazebo::ArrangePlugin:

Classes
class	Object
	Class to store info about each object. More...

Public Member Functions
	ArrangePlugin ()
	Constructor. More...
	~ArrangePlugin ()
	Destructor. More...
void	ArrangementCallback (ConstGzStringPtr &_msg)
	Callback function which receives a requested arrangement name. More...
virtual void	Init ()
	Initialize the plugin. More...
virtual void	Load (physics::WorldPtr _world, sdf::ElementPtr _sdf)
	Load the plugin. More...
virtual void	Reset ()
	Reset the plugin. More...
bool	SetArrangement (const std::string &_arrangement)
	Set up the arrangement with name given by input parameter. More...
Public Member Functions inherited from gazebo::WorldPlugin
	WorldPlugin ()
	Constructor. More...
virtual	~WorldPlugin ()
	Destructor. More...
Public Member Functions inherited from gazebo::PluginT< WorldPlugin >
	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...

Protected Types
typedef std::map< std::string, Pose_M >	Arrangement_M
	Map of strings to Pose_M (arrangement map). More...
typedef std::map< std::string, ObjectPtr >	Object_M
	Map of strings to model pointers. More...
typedef boost::shared_ptr< Object >	ObjectPtr
typedef std::map< std::string, math::Pose >	Pose_M
	Map of strings to model poses. More...

Protected Attributes
Arrangement_M	arrangements
	Information about arrangements. More...
std::string	currentArrangementName
	Current arrangement name. More...
std::string	eventTopicName
	Topic to listen on for changing arrangments. More...
std::string	initialArrangementName
	Initial arrangement name. More...
transport::NodePtr	node
	Node for Gazebo transport. More...
Object_M	objects
	Collection of models. More...
sdf::ElementPtr	sdf
	SDF pointer. More...
transport::SubscriberPtr	sub
	Subscriber for listening to changing arrangements. More...
physics::WorldPtr	world
	World pointer. More...
Protected Attributes inherited from gazebo::PluginT< WorldPlugin >
std::string	filename
	Path to the shared library file. More...
std::string	handleName
	Short name. More...
PluginType	type
	Type of plugin. More...

Additional Inherited Members
Public Types inherited from gazebo::PluginT< WorldPlugin >
typedef boost::shared_ptr < WorldPlugin >	TPtr
	plugin pointer type definition More...
Static Public Member Functions inherited from gazebo::PluginT< WorldPlugin >
static TPtr	Create (const std::string &_filename, const std::string &_name)
	a class method that creates a plugin from a file name. More...

Member Typedef Documentation

typedef std::map<std::string, Pose_M> gazebo::ArrangePlugin::Arrangement_M

protected

Map of strings to Pose_M (arrangement map).

typedef std::map<std::string, ObjectPtr> gazebo::ArrangePlugin::Object_M

protected

Map of strings to model pointers.

typedef boost::shared_ptr<Object> gazebo::ArrangePlugin::ObjectPtr

protected

typedef std::map<std::string, math::Pose> gazebo::ArrangePlugin::Pose_M

protected

Map of strings to model poses.

Constructor & Destructor Documentation

gazebo::ArrangePlugin::ArrangePlugin

(

)

Constructor.

gazebo::ArrangePlugin::~ArrangePlugin

(

)

Destructor.

Member Function Documentation

void gazebo::ArrangePlugin::ArrangementCallback

(

ConstGzStringPtr &

_msg

)

Callback function which receives a requested arrangement name.

virtual void gazebo::ArrangePlugin::Init ( )

virtual

Initialize the plugin.

Reimplemented from gazebo::WorldPlugin.

virtual void gazebo::ArrangePlugin::Load ( physics::WorldPtr  _world, sdf::ElementPtr  _sdf  )

virtual

Load the plugin.

Parameters

[in]	_world	Pointer to world
[in]	_sdf	Pointer to the SDF configuration.

Implements gazebo::WorldPlugin.

virtual void gazebo::ArrangePlugin::Reset ( )

virtual

Reset the plugin.

Reimplemented from gazebo::WorldPlugin.

bool gazebo::ArrangePlugin::SetArrangement

(

const std::string &

_arrangement

)

Set up the arrangement with name given by input parameter.

Parameters

[in]

_arrangement

Name of arrangement.

Returns

True if arrangement was set successfully.

Member Data Documentation

Arrangement_M gazebo::ArrangePlugin::arrangements

protected

Information about arrangements.

std::string gazebo::ArrangePlugin::currentArrangementName

protected

Current arrangement name.

std::string gazebo::ArrangePlugin::eventTopicName

protected

Topic to listen on for changing arrangments.

std::string gazebo::ArrangePlugin::initialArrangementName

protected

Initial arrangement name.

transport::NodePtr gazebo::ArrangePlugin::node

protected

Node for Gazebo transport.

Object_M gazebo::ArrangePlugin::objects

protected

Collection of models.

sdf::ElementPtr gazebo::ArrangePlugin::sdf

protected

SDF pointer.

transport::SubscriberPtr gazebo::ArrangePlugin::sub

protected

Subscriber for listening to changing arrangements.

physics::WorldPtr gazebo::ArrangePlugin::world

protected

World pointer.

---

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

• ArrangePlugin.hh