Information about a plugin that should be loaded by the server. More...

#include <ServerConfig.hh>

Public Member Functions
	PluginInfo ()
	Default constructor. More...

	PluginInfo (const PluginInfo &_info)
	Copy constructor. More...

	PluginInfo (const std::string &_entityName, const std::string &_entityType, const sdf::Plugin &_plugin)
	Constructor with plugin information specified. More...

	PluginInfo (const std::string &_entityName, const std::string &_entityType, const std::string &_filename, const std::string &_name, const sdf::ElementPtr &_sdf)
	Constructor with plugin information specified. More...

	~PluginInfo ()
	Destructor. More...

const std::string &	EntityName () const
	Get the name of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity. More...

const std::string &	EntityType () const
	Get the entity type which should receive this plugin. The type is used in conjuction with EntityName to uniquely identify an entity. More...

const std::string &	Filename () const
	Get the plugin library filename. More...

const std::string &	Name () const
	Name of the interface within the plugin library to load. More...

PluginInfo &	operator= (const PluginInfo &_info)
	Equal operator. More...

sdf::Plugin &	Plugin ()
	Get a mutable version of the SDF plugin information. More...

const sdf::Plugin &	Plugin () const
	Get the SDF plugin information. More...

const sdf::ElementPtr &	Sdf () const
	Plugin XML elements associated with this plugin. More...

void	SetEntityName (const std::string &_entityName)
	Set the name of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity. More...

void	SetEntityType (const std::string &_entityType)
	Set the type of the entity which should receive this plugin. The type is used in conjuction with EntityName to uniquely identify an entity. More...

void	SetFilename (const std::string &_filename)
	Set the type of the entity which should receive this plugin. The type is used in conjuction with EntityName to uniquely identify an entity. More...

void	SetName (const std::string &_name)
	Set the name of the interface within the plugin library to load. More...

void	SetPlugin (const sdf::Plugin &_plugin) const
	Set the SDF plugin information. More...

void	SetSdf (const sdf::ElementPtr &_sdf)
	Set the plugin XML elements associated with this plugin. More...

Detailed Description

Information about a plugin that should be loaded by the server.

Currently supports attaching a plugin to an entity given its type and name, but it can't tell apart multiple entities with the same name in different parts of the entity tree.

See also: const std::list<PluginInfo> &Plugins() const

Constructor & Destructor Documentation

◆ PluginInfo() [1/4]

PluginInfo ( )

Default constructor.

◆ ~PluginInfo()

~PluginInfo ( )

Destructor.

◆ PluginInfo() [2/4]

PluginInfo	(	const std::string &	_entityName,
		const std::string &	_entityType,
		const std::string &	_filename,
		const std::string &	_name,
		const sdf::ElementPtr &	_sdf
	)

Constructor with plugin information specified.

Parameters

[in]	_entityName	Name of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity.
[in]	_entityType	Entity type which should receive this plugin. The type is used in conjuction with _entityName to uniquely identify an entity.
[in]	_filename	Plugin library filename.
[in]	_name	Name of the interface within the plugin library to load.
[in]	_sdf	Plugin XML elements associated with this plugin.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

◆ PluginInfo() [3/4]

PluginInfo	(	const std::string &	_entityName,
		const std::string &	_entityType,
		const sdf::Plugin &	_plugin
	)

Constructor with plugin information specified.

Parameters

[in]	_entityName	Name of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity.
[in]	_entityType	Entity type which should receive this plugin. The type is used in conjuction with _entityName to uniquely identify an entity.
[in]	_plugin	SDF Plugin library information.

◆ PluginInfo() [4/4]

PluginInfo ( const PluginInfo & _info )

Copy constructor.

Parameters

[in] _info Plugin to copy.

Member Function Documentation

◆ EntityName()

const std::string& EntityName ( ) const

Get the name of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity.

Returns: Entity name.

◆ EntityType()

const std::string& EntityType ( ) const

Get the entity type which should receive this plugin. The type is used in conjuction with EntityName to uniquely identify an entity.

Returns: Entity type string.

◆ Filename()

const std::string& Filename ( ) const

Get the plugin library filename.

Returns: Plugin library filename.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

◆ Name()

const std::string& Name ( ) const

Name of the interface within the plugin library to load.

Returns: Interface name.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

◆ operator=()

PluginInfo& operator= ( const PluginInfo & _info )

Equal operator.

Parameters

[in] _info PluginInfo to copy.

Returns: Reference to this class.

◆ Plugin() [1/2]

sdf::Plugin& Plugin ( )

Get a mutable version of the SDF plugin information.

Returns: The SDF Plugin object.

◆ Plugin() [2/2]

const sdf::Plugin& Plugin ( ) const

Get the SDF plugin information.

Returns: The SDF Plugin object.

◆ Sdf()

const sdf::ElementPtr& Sdf ( ) const

Plugin XML elements associated with this plugin.

Returns: SDF pointer.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

◆ SetEntityName()

void SetEntityName ( const std::string & _entityName )

Set the name of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity.

Parameters

[in] _entityName Entity name.

◆ SetEntityType()

void SetEntityType ( const std::string & _entityType )

Set the type of the entity which should receive this plugin. The type is used in conjuction with EntityName to uniquely identify an entity.

Parameters

[in] _entityType Entity type string.

◆ SetFilename()

void SetFilename ( const std::string & _filename )

Set the type of the entity which should receive this plugin. The type is used in conjuction with EntityName to uniquely identify an entity.

Parameters

[in] _filename Entity type string.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

◆ SetName()

void SetName ( const std::string & _name )

Set the name of the interface within the plugin library to load.

Parameters

[in] _name Interface name.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

◆ SetPlugin()

void SetPlugin ( const sdf::Plugin & _plugin ) const

Set the SDF plugin information.

Parameters

[in] _plugin The SDF Plugin object to use.

◆ SetSdf()

void SetSdf ( const sdf::ElementPtr & _sdf )

Set the plugin XML elements associated with this plugin.

Parameters

[in] _sdf SDF pointer, it will be cloned.

Note: This will be deprecated in Gazebo 7 (Garden), please the use sdf::Plugin interface.

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

gz/sim/ServerConfig.hh

Gazebo Gazebo

API Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PluginInfo() [1/4]

◆ ~PluginInfo()

◆ PluginInfo() [2/4]

◆ PluginInfo() [3/4]

◆ PluginInfo() [4/4]

Member Function Documentation

◆ EntityName()

◆ EntityType()

◆ Filename()

◆ Name()

◆ operator=()

◆ Plugin() [1/2]

◆ Plugin() [2/2]

◆ Sdf()

◆ SetEntityName()

◆ SetEntityType()

◆ SetFilename()

◆ SetName()

◆ SetPlugin()

◆ SetSdf()