Gazebo Gazebo

API Reference

3.15.1
ServerConfig::PluginInfo Class Reference

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 std::string &_filename, const std::string &_name, const sdf::ElementPtr &_sdf)
 Constructor with plugin information specified. More...
 
 ~PluginInfo ()
 Destructor. More...
 
const std::stringEntityName () 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::stringEntityType () 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::stringFilename () const
 Get the plugin library filename. More...
 
const std::stringName () const
 Name of the interface within the plugin library to load. More...
 
PluginInfooperator= (const PluginInfo &_info)
 Equal operator. 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 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/3]

Default constructor.

◆ ~PluginInfo()

~PluginInfo ( )

Destructor.

◆ PluginInfo() [2/3]

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]_entityNameName of the entity which should receive this plugin. The name is used in conjuction with _entityType to uniquely identify an entity.
[in]_entityTypeEntity type which should receive this plugin. The type is used in conjuction with _entityName to uniquely identify an entity.
[in]_filenamePlugin library filename.
[in]_nameName of the interface within the plugin library to load.
[in]_sdfPlugin XML elements associated with this plugin.

◆ PluginInfo() [3/3]

PluginInfo ( const PluginInfo _info)

Copy constructor.

Parameters
[in]_infoPlugin 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.

◆ Name()

const std::string& Name ( ) const

Name of the interface within the plugin library to load.

Returns
Interface name.

◆ operator=()

PluginInfo& operator= ( const PluginInfo _info)

Equal operator.

Parameters
[in]_infoPluginInfo to copy.
Returns
Reference to this class.

◆ Sdf()

const sdf::ElementPtr& Sdf ( ) const

Plugin XML elements associated with this plugin.

Returns
SDF pointer.

◆ 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]_entityNameEntity 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]_entityTypeEntity 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]_filenameEntity type string.

◆ SetName()

void SetName ( const std::string _name)

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

Parameters
[in]_nameInterface name.

◆ SetSdf()

void SetSdf ( const sdf::ElementPtr &  _sdf)

Set the plugin XML elements associated with this plugin.

Parameters
[in]_sdfSDF pointer, it will be cloned.

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