DianaBooleanParameterSpec Class Reference

#include <DianaParameter.hpp>

Inheritance diagram for DianaBooleanParameterSpec:

List of all members.

Public Member Functions
	DianaBooleanParameterSpec (const Common::Types::CapeString &name, const Common::Types::CapeString &description=Common::Types::CapeStringUNDEFINED, Common::Types::CapeBoolean _defaultValue=false)
Common::Identification::ICapeIdentification *	clone () throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
const Common::Types::CapeString &	GetComponentName () const throw (Common::Error::ECapeUnknown)
void	SetComponentName (const Common::Types::CapeString &_name) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
const Common::Types::CapeString &	GetComponentDescription () const throw (Common::Error::ECapeUnknown)
void	SetComponentDescription (const Common::Types::CapeString &_description) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
Common::Parameter::CapeParamType	Type () const throw (Common::Error::ECapeUnknown)
Common::Types::CapeVariant	Dimensionality () const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Common::Types::CapeBoolean	DefaultValue () const throw (Common::Error::ECapeUnknown)
void	setDefaultValue (Common::Types::CapeBoolean _val)
Common::Types::CapeBoolean	Validate (Common::Types::CapeBoolean value, Common::Types::CapeString &message) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl)
Protected Attributes
Common::Types::CapeString	name
	specification name
Common::Types::CapeString	description
	specification description
Common::Types::CapeBoolean	defaultValue
	parameter default value

---

Detailed Description

Diana realization of the ICapeBooleanParameterSpec interface.

---

Constructor & Destructor Documentation

DianaBooleanParameterSpec	(	const Common::Types::CapeString &	name,
		const Common::Types::CapeString &	description = Common::Types::CapeStringUNDEFINED,
		Common::Types::CapeBoolean	_defaultValue = false
	)

Constructor.

---

Member Function Documentation

Common::Identification::ICapeIdentification* clone

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [virtual]

Creates a new copy in the memory of the DianaBooleanParameterSpec object.

Reimplemented from ICapeIdentification.

Common::Types::CapeBoolean DefaultValue

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

Gets the default value of the boolean valued parameter for which this is the specification.

Implements ICapeBooleanParameterSpec.

Common::Types::CapeVariant Dimensionality

(

)

const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [virtual]

Gets the dimensionality of the parameter for which this is the specification. The dimensionality represents the physical dimensional axes of this parameter. It is expected that the dimensionality must cover at least 6 fundamental axes (length, mass, time, angle, temperature and charge).

Implements ICapeParameterSpec.

const Common::Types::CapeString& GetComponentDescription

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

gets the description of the component.

Implements ICapeIdentification.

const Common::Types::CapeString& GetComponentName

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

gets the name of the component.

Implements ICapeIdentification.

void SetComponentDescription

(

const Common::Types::CapeString &

_description

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

sets the description of the component.

Parameters:

_description

the description of the component

Implements ICapeIdentification.

void SetComponentName

(

const Common::Types::CapeString &

_name

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

sets the name of the component.

Parameters:

_name

the name of the component

Implements ICapeIdentification.

void setDefaultValue

(

Common::Types::CapeBoolean

_val

)

set the default Value, this is not CAPE

Common::Parameter::CapeParamType Type

(

)

const throw (Common::Error::ECapeUnknown) [virtual]

Returns boolean type (CAPE_BOOLEAN).

Implements ICapeParameterSpec.

Common::Types::CapeBoolean Validate	(	Common::Types::CapeBoolean	value,
		Common::Types::CapeString &	message
	)		throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [virtual]

Validates a boolean value against its specification. It returns a flag to indicate the success or failure of the validation together with a text message which can be used to convey the reasoning to the client/user. The flag is True for success and False for failure. Currently not implemented.

Parameters:

value	the value of the parameter to validate
message	message conveying information regarding the validation

Implements ICapeBooleanParameterSpec.

---

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

• DianaParameter.hpp