#include <DianaParameter.hpp>

Inheritance diagram for DianaParameter:

Classes
class	PtrData
Public Member Functions
	DianaParameter (const DianaParameter &param)
DianaParameter &	operator= (const DianaParameter &param)
	DianaParameter (const DianaRealParameterSpec &spec, Common::Parameter::CapeParamMode _mode, const PtrData &_ptr)
	DianaParameter (const DianaRealParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const Diana::DianaNLPRealParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const DianaStateSpec &spec, Common::Parameter::CapeParamMode _mode, const PtrData &_ptr)
	DianaParameter (const DianaIntegerParameterSpec &spec, Common::Parameter::CapeParamMode _mode, const PtrData &_ptr)
	DianaParameter (const DianaIntegerParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const DianaBooleanParameterSpec &spec, Common::Parameter::CapeParamMode _mode, const PtrData &_ptr)
	DianaParameter (const DianaBooleanParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const DianaOptionParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const DianaPointerParameterSpec &spec, Common::Parameter::CapeParamMode _mode, const PtrData &_ptr)
	DianaParameter (const DianaArrayParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const DianaArrayRealParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
	DianaParameter (const DianaArrayStringParameterSpec &spec, Common::Parameter::CapeParamMode _mode)
virtual	~DianaParameter ()
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::Types::CapeVariant	GetValue () throw (Common::Error::ECapeUnknown)
virtual void	SetValue (const Common::Types::CapeVariant &_value) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
Common::Types::CapeValidationStatus	ValStatus () const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Common::Parameter::CapeParamMode	GetMode () const throw (Common::Error::ECapeUnknown)
void	SetMode (Common::Parameter::CapeParamMode _mode) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
Common::Parameter::ICapeParameterSpec *	Specification () const throw (Common::Error::ECapeUnknown)
Common::Types::CapeBoolean	Validate (Common::Types::CapeString &message) throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
void	Reset () throw (Common::Error::ECapeUnknown)
Common::Identification::ICapeIdentification *	clone () throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Common::Identification::ICapeIdentification *	clone (const PtrData &_ptr) throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Protected Member Functions
void	updateValueByPointer (Common::Types::CapeBoolean bUpdateDirection) throw (Common::Error::ECapeUnknown)
void	updateArrayValue (Common::Types::CapeBoolean bUpdateDirection) throw (Common::Error::ECapeUnknown)
void	updateValue (Common::Types::CapeBoolean bUpdateDirection) throw (Common::Error::ECapeUnknown)
Protected Attributes
Common::Types::CapeString	name
	parameter name
Common::Types::CapeString	description
	parameter description
Common::Parameter::ICapeParameterSpec *	specification
	parameter specification
Common::Parameter::CapeParamMode	mode
	parameter I/O mode
Common::Types::CapeVariant	value
	current parameter value
PtrData	ptrInternal

Detailed Description

Diana realization of the ICapeParameter interface.

Constructor & Destructor Documentation

DianaParameter ( const DianaParameter & param )

Copy constructor.

DianaParameter	(	const DianaRealParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode,
		const PtrData &	_ptr
	)

Real specification constructor.

DianaParameter	(	const DianaRealParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

Real specification constructor.

DianaParameter	(	const Diana::DianaNLPRealParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

Real specification for nlp task constructor.

DianaParameter	(	const DianaStateSpec &	spec,
		Common::Parameter::CapeParamMode	_mode,
		const PtrData &	_ptr
	)

State specification constructor.

DianaParameter	(	const DianaIntegerParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode,
		const PtrData &	_ptr
	)

Integer specification constructor.

DianaParameter	(	const DianaIntegerParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

Integer specification constructor.

DianaParameter	(	const DianaBooleanParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode,
		const PtrData &	_ptr
	)

Boolean specification constructor.

DianaParameter	(	const DianaBooleanParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

Boolean specification constructor.

DianaParameter	(	const DianaOptionParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

Option specification constructor.

DianaParameter	(	const DianaPointerParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode,
		const PtrData &	_ptr
	)

Pointer specification constructor.

DianaParameter	(	const DianaArrayParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

DianaArrayParameterSpec specification constructor.

DianaParameter	(	const DianaArrayRealParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

DianaArrayRealParameterSpec specification constructor.

DianaParameter	(	const DianaArrayStringParameterSpec &	spec,
		Common::Parameter::CapeParamMode	_mode
	)

DianaArrayStringParameterSpec specification constructor.

virtual ~DianaParameter ( ) [virtual]

Parameter destructor.

Member Function Documentation

Common::Identification::ICapeIdentification* clone ( ) throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [virtual]

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

Reimplemented from ICapeIdentification.

Common::Identification::ICapeIdentification* clone ( const PtrData & _ptr ) throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)

Creates a new copy in the memory of the DianaParameter object with new internal parameter data.

This method is special for the DianaParameter only.

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::Parameter::CapeParamMode GetMode ( ) const throw (Common::Error::ECapeUnknown) [virtual]

Gets the mode in which the unit will interpret the parameter. It allows the following values:

Input (CAPE_INPUT): the Unit(or whichever owner component) will use its value to calculate.
Output (CAPE_OUTPUT): the Unit will place in the parameter a result of its calculations.
Input-Output (CAPE_INPUT_OUTPUT): the user inputs an initial estimation value and the user outputs a calculated value.

Implements ICapeParameter.

Common::Types::CapeVariant GetValue ( ) throw (Common::Error::ECapeUnknown) [virtual]

Gets the value of this parameter. Passed as a CapeVariant that should be the same type as the Parameter type.

Implements ICapeParameter.

DianaParameter& operator= ( const DianaParameter & param )

Assignment constructor.

void Reset ( ) throw (Common::Error::ECapeUnknown) [virtual]

Sets the value of the parameter to its default value.

Implements ICapeParameter.

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 SetMode ( Common::Parameter::CapeParamMode _mode ) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

Sets the mode in which the unit will interpret the parameter. It allows the following values:

Input (CAPE_INPUT): the Unit(or whichever owner component) will use its value to calculate.
Output (CAPE_OUTPUT): the Unit will place in the parameter a result of its calculations.
Input-Output (CAPE_INPUT_OUTPUT): the user inputs an initial estimation value and the user outputs a calculated value.
Parameters:

_mode the flag that indicates whether the Unit should take the parameter as input or as output

Implements ICapeParameter.

virtual void SetValue ( const Common::Types::CapeVariant & _value ) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [virtual]

Sets the value of this parameter. Passed as a CapeVariant that should be the same type as the Parameter type, if not this is an error (invalid argument).

Parameters:

_value the value of this parameter.

Implements ICapeParameter.

Reimplemented in PetriPlace.

Referenced by SingAnalyser::calcTestCondition().

Common::Parameter::ICapeParameterSpec* Specification ( ) const throw (Common::Error::ECapeUnknown) [virtual]

Gets the specification of the parameter. The Get method returns the specification as an interface to the correct specification type.

Implements ICapeParameter.

void updateValueByPointer ( Common::Types::CapeBoolean bUpdateDirection ) throw (Common::Error::ECapeUnknown) [protected]

Updates parameter value.

Parameters:

bUpdateDirection

update direction:

true updates internal CapeVariant value and value specified by pointer with desired CapeVariant value.
false updates value specified by pointer

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

Checks if the value of the parameter is valid in specification terms and in any other terms that are specialised.

Parameters:

message message conveying information regarding the validation

Implements ICapeParameter.

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

Gets the flag to indicate parameter validation status (currently not implemented). It has three possible values:

notValidated(CAPE_NOT_VALIDATED): its validate() method has not been called after the last time that its value had been changed.
invalid(CAPE_INVALID): the last time that its validate() method was called it returned false.
valid(CAPE_VALID): the last time that its validate() method was called it returned true.

Implements ICapeParameter.

Member Data Documentation

PtrData ptrInternal [protected]

internal pointer on the ICapeUtility parameter. to avoid such type of parameter value access should be changed functions Get(Set)Value.

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

DianaParameter.hpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation