DianaIntegerParameterSpec Class Reference

#include <DianaParameter.hpp>

Inheritance diagram for DianaIntegerParameterSpec:

List of all members.

Public Member Functions
	DianaIntegerParameterSpec (const Common::Types::CapeString &name, const Common::Types::CapeString &description=Common::Types::CapeStringUNDEFINED, Common::Types::CapeLong _defaultValue=0, Common::Types::CapeLong _lowerBound=0, Common::Types::CapeLong _upperBound=0)
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::CapeLong	DefaultValue () const throw (Common::Error::ECapeUnknown)
void	setDefaultValue (Common::Types::CapeLong _val)
Common::Types::CapeLong	LowerBound () const throw (Common::Error::ECapeUnknown)
void	setLowerBound (Common::Types::CapeLong lb)
Common::Types::CapeLong	UpperBound () const throw (Common::Error::ECapeUnknown)
void	setUpperBound (Common::Types::CapeLong ub)
Common::Types::CapeBoolean	Validate (Common::Types::CapeLong 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::CapeLong	defaultValue
	parameter default value
Common::Types::CapeLong	lowerBound
	parameter lower bound
Common::Types::CapeLong	upperBound
	parameter upper bound

---

Detailed Description

Diana realization of the ICapeIntegerParameterSpec interface.

---

Constructor & Destructor Documentation

DianaIntegerParameterSpec	(	const Common::Types::CapeString &	name,
		const Common::Types::CapeString &	description = Common::Types::CapeStringUNDEFINED,
		Common::Types::CapeLong	_defaultValue = 0,
		Common::Types::CapeLong	_lowerBound = 0,
		Common::Types::CapeLong	_upperBound = 0
	)

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 DianaIntegerParameterSpec object.

Reimplemented from ICapeIdentification.

Common::Types::CapeLong DefaultValue

(

)

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

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

Implements ICapeIntegerParameterSpec.

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.

Common::Types::CapeLong LowerBound

(

)

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

Gets the lower bound of the integer valued parameter for which this is the specification.

Implements ICapeIntegerParameterSpec.

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::CapeLong

_val

)

set the default Value, this is not CAPE

void setLowerBound

(

Common::Types::CapeLong

lb

)

set the lower Bound, this is not CAPE

void setUpperBound

(

Common::Types::CapeLong

ub

)

set the lower Bound, this is not CAPE

Common::Parameter::CapeParamType Type

(

)

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

Returns integer type (CAPE_INT).

Implements ICapeParameterSpec.

Common::Types::CapeLong UpperBound

(

)

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

Gets the upper bound of the integer valued parameter for which this is the specification.

Implements ICapeIntegerParameterSpec.

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

Validates a integer 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 ICapeIntegerParameterSpec.

---

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

• DianaParameter.hpp