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.
	PluginInfo (const PluginInfo &_info)
	Copy constructor.
	PluginInfo (const std::string &_entityName, const std::string &_entityType, const sdf::Plugin &_plugin)
	Constructor with plugin information specified.
	~PluginInfo ()
	Destructor.
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.
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.
PluginInfo &	operator= (const PluginInfo &_info)
	Equal operator.
sdf::Plugin &	Plugin ()
	Get a mutable version of the SDF plugin information.
const sdf::Plugin &	Plugin () const
	Get the SDF plugin information.
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.
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.
void	SetPlugin (const sdf::Plugin &_plugin) const
	Set the SDF plugin information.

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]

PluginInfo

(

)

Default constructor.

~PluginInfo()

~PluginInfo

(

)

Destructor.

PluginInfo() [2/3]

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() [3/3]

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.

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.

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.

SetPlugin()

void SetPlugin

(

const sdf::Plugin &

_plugin

)

const

Set the SDF plugin information.

Parameters

[in]

_plugin

The SDF Plugin object to use.

---

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

• ServerConfig.hh