rrp::Capability Class Reference

#include <rrCapability.h>

Public Member Functions
	Capability (const string &name, const string &descr)
	~Capability ()
	Capability (const Capability &fromMe)
string	getName () const
string	getDescription () const
Parameters *	getParameters ()
PluginParameter *	getParameter (const string &paraName)
void	setup (const string &name, const string &descr)
void	addParameter (PluginParameter *me)
string	asString () const
u_int	nrOfParameters () const
PluginParameter &	operator[] (const int &i)

Protected Attributes
string	mName
string	mDescription
Parameters	mParameters

Friends
ostream &	operator<< (ostream &os, const Capability &caps)

Detailed Description

A Capability. A capability is a basically a container of parameters, with the addition of a name and description.

Todo:

Might be better just inherit from Parameters and add the name, descr variables.

Constructor & Destructor Documentation

rrp::Capability::Capability	(	const string &	name,
		const string &	descr
	)

Create a capability

rrp::Capability::~Capability

(

)

De allocate any memory associated with the capability

rrp::Capability::Capability

(

const Capability &

fromMe

)

Create a capability from another capability (copy ctor)

Member Function Documentation

void rrp::Capability::addParameter

(

PluginParameter *

me

)

Add a parameter to the capability

string rrp::Capability::asString

(

)

const

Get the capability as a string

string rrp::Capability::getDescription

(

)

const

Get capability description

string rrp::Capability::getName

(

)

const

Get capability name

PluginParameter * rrp::Capability::getParameter

(

const string &

paraName

)

Get a pointer to a parameter with a specific name

Parameters * rrp::Capability::getParameters

(

)

Get a pointers to the underlying parameter container

u_int rrp::Capability::nrOfParameters

(

)

const

Get number of parameters

PluginParameter & rrp::Capability::operator[]

(

const int &

i

)

Get a reference to a parameter

void rrp::Capability::setup	(	const string &	name,
		const string &	descr
	)

Assign name and description

Friends And Related Function Documentation

ostream& operator<< ( ostream &  os, const Capability &  caps  )

friend

Output the capability to a output stream

Member Data Documentation

string rrp::Capability::mDescription

protected

A description of the capability

string rrp::Capability::mName

protected

Name of capability

Parameters rrp::Capability::mParameters

protected

Container for parameters associated with the capability

---

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

• rrCapability.h
• rrCapability.cpp