rci::ControlAspect Class Reference

Domain object indicating one aspect of control (e.g. More...

#include <ControlAspect.h>

Collaboration diagram for rci::ControlAspect:

[legend]

List of all members.

Public Member Functions
	ControlAspect (const std::string &name, const std::string &ID)
	Constructor, initializing control to desired mode.
virtual	~ControlAspect ()
	Destructor.
std::string	getID () const
	Returns unique identifier of the control mode instance.
std::string	getName () const
	Returns name.
bool	equals (const ControlAspectPtr &mode) const
	Returns wheather this ControlAspect is the passed one.
bool	operator< (const ControlAspectPtr &compare)
	Less operator.
std::string	print () const
Static Public Member Functions
static ControlAspectPtr	create (const std::string &name, const std::string &ID)
	Initializes control to desired mode.
Protected Attributes
std::string	name
	Name of the control mode.
std::string	ID
	Identifier of this control mode.
Private Member Functions
	ControlAspect (const ControlAspect &ControlAspect)
	Copy constructor.

---

Detailed Description

Domain object indicating one aspect of control (e.g.

position control).

Todo:

Should have constructor with ControlAspect vector as third parameter

Control Mode combination should be commutative.

Definition at line 44 of file ControlAspect.h.

---

Constructor & Destructor Documentation

rci::ControlAspect::ControlAspect	(	const std::string &	name,
		const std::string &	ID
	)

Constructor, initializing control to desired mode.

Parameters:

	name	Name of the control mode
	ID	Identifier for this control mdoe

Returns:

Control mode object, set to 0 (disabled)

Definition at line 36 of file ControlAspect.cpp.

Referenced by create().

Here is the caller graph for this function:

rci::ControlAspect::~ControlAspect

(

)

[virtual]

Destructor.

Definition at line 40 of file ControlAspect.cpp.

rci::ControlAspect::ControlAspect

(

const ControlAspect &

ControlAspect

)

[private]

Copy constructor.

Private to disallow copying.

---

Member Function Documentation

ControlAspectPtr rci::ControlAspect::create	(	const std::string &	name,
		const std::string &	ID
	)			[static]

Initializes control to desired mode.

Parameters:

	name	Name of the control mode
	ID	Identifier for this control mdoe

Returns:

Control mode object, set to 0 (disabled)

Definition at line 59 of file ControlAspect.cpp.

References ControlAspect().

Here is the call graph for this function:

bool rci::ControlAspect::equals

(

const ControlAspectPtr &

mode

)

const

Returns wheather this ControlAspect is the passed one.

Parameters:

mode

ControlAspect to compare with.

Returns:

Are the two ControlAspects equal to each other?

Definition at line 51 of file ControlAspect.cpp.

References getID().

Here is the call graph for this function:

std::string rci::ControlAspect::getID

(

)

const

Returns unique identifier of the control mode instance.

Returns:

Unique identifier (uuid)

Definition at line 47 of file ControlAspect.cpp.

References ID.

Referenced by equals(), and operator<().

Here is the caller graph for this function:

std::string rci::ControlAspect::getName

(

)

const

Returns name.

Returns:

Name

Definition at line 43 of file ControlAspect.cpp.

References name.

bool rci::ControlAspect::operator<

(

const ControlAspectPtr &

compare

)

Less operator.

Just for the sake of definiong an order on ControlAspect.

Definition at line 55 of file ControlAspect.cpp.

References getID().

Here is the call graph for this function:

std::string rci::ControlAspect::print

(

)

const

Definition at line 65 of file ControlAspect.cpp.

References ID.

---

Member Data Documentation

std::string rci::ControlAspect::ID [protected]

Identifier of this control mode.

Definition at line 106 of file ControlAspect.h.

Referenced by getID(), and print().

std::string rci::ControlAspect::name [protected]

Name of the control mode.

Definition at line 101 of file ControlAspect.h.

Referenced by getName().

---

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

• rci/ControlAspect.h
• rci/ControlAspect.cpp