Contains information for a plugin configuration entry. More...

#include <nPluginConfigEntry.h>

Public Member Functions
const std::string &	getDescription ()
	Returns the a string describing what this configuration entry is. More...

const std::string &	getName ()
	Returns the name of the configuration entry. More...

const std::string &	getValue ()
	Returns the current value. More...

	nPluginConfigEntry (const std::string &name, const std::string &desc, const std::string &value)
	Construct a new nPluginConfigEntry. More...

void	setValue (const std::string &value)
	Sets the value to the string specified. More...

std::string	toString ()
	String of the object. More...

Detailed Description

Contains information for a plugin configuration entry.

This data contains the name of the configuration, a description of what this entry does and the current value.

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nPluginConfigEntry::nPluginConfigEntry	(	const std::string &	name,
		const std::string &	desc,
		const std::string &	value
	)

Parameters

name	the string name of this entry
desc	the string description of this entry
value	the vale of this entry

const std::string& com::pcbsys::nirvana::nAdminAPI::nPluginConfigEntry::getDescription ( )

Returns the a string describing what this configuration entry is.

const std::string& com::pcbsys::nirvana::nAdminAPI::nPluginConfigEntry::getName ( )

Returns the name of the configuration entry.

const std::string& com::pcbsys::nirvana::nAdminAPI::nPluginConfigEntry::getValue ( )

Returns the current value.

void com::pcbsys::nirvana::nAdminAPI::nPluginConfigEntry::setValue ( const std::string & value )

Sets the value to the string specified.

Parameters

myValue new value.

std::string com::pcbsys::nirvana::nAdminAPI::nPluginConfigEntry::toString ( )

String of the object.