DianaArrayStringParameterSpec Class Reference

#include <DianaParameter.hpp>

Inheritance diagram for DianaArrayStringParameterSpec:

List of all members.

Public Member Functions
	DianaArrayStringParameterSpec (const Common::Types::CapeString &name, const Common::Types::CapeString &description=Common::Types::CapeStringUNDEFINED)
	DianaArrayStringParameterSpec (const Common::Types::CapeString &name, const Common::Types::CapeString &description, const Common::Types::CapeArrayString &_defaultValue, const Common::Types::CapeArrayString &_optionList)
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)
const Common::Types::CapeArrayString &	DefaultValue () const throw (Common::Error::ECapeUnknown)
const Common::Types::CapeArrayString &	OptionList () const throw (Common::Error::ECapeUnknown)
Common::Types::CapeBoolean	RestrictedToList () const throw (Common::Error::ECapeUnknown)
Common::Types::CapeBoolean	Validate (Common::Types::CapeString 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::CapeArrayString	defaultValue
	parameter default value
Common::Types::CapeArrayString	optionList
	parameters list
Common::Types::CapeBoolean	bRestricted

---

Detailed Description

Array of strings parameter specification. Specification defines options list and default value.

---

Constructor & Destructor Documentation

DianaArrayStringParameterSpec	(	const Common::Types::CapeString &	name,
		const Common::Types::CapeString &	description = Common::Types::CapeStringUNDEFINED
	)

Constructor with a empty options list.

DianaArrayStringParameterSpec	(	const Common::Types::CapeString &	name,
		const Common::Types::CapeString &	description,
		const Common::Types::CapeArrayString &	_defaultValue,
		const Common::Types::CapeArrayString &	_optionList
	)

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

Reimplemented from ICapeIdentification.

const Common::Types::CapeArrayString& DefaultValue

(

)

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

Gets the default value that the parameter will take. Since it does not indicate an index of the option list, it is allowed to set any default value when the optionList is empty.

Implements IDianaArrayStringParameterSpec.

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.

const Common::Types::CapeArrayString& OptionList

(

)

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

Gets the list of possible values that the parameter may take. If attribute restrictedToList is false, then the parameter may also accept other values.

Implements IDianaArrayStringParameterSpec.

Common::Types::CapeBoolean RestrictedToList

(

)

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

States whether the parameter allows to set values different to the ones contained in the option list.

Implements IDianaArrayStringParameterSpec.

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.

Common::Parameter::CapeParamType Type

(

)

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

Returns option type (CAPE_OPTION).

Implements ICapeParameterSpec.

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

Validates whether the string argument is accepted by the parameter as a valid value. 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.

Parameters:

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

Implements IDianaArrayStringParameterSpec.

---

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

• DianaParameter.hpp