Diana  0.8.3
Public Member Functions | Protected Attributes
DianaPointerParameterSpec Class Reference

#include <DianaParameter.hpp>

Inheritance diagram for DianaPointerParameterSpec:
ICapePointerParameterSpec ICapeParameterSpec ICapeIdentification

List of all members.

Public Member Functions

 DianaPointerParameterSpec (const Common::Types::CapeString &name, const Common::Types::CapeString &description=Common::Types::CapeStringUNDEFINED, Common::Types::CapePointer _defaultValue=NULL)
Common::Identification::ICapeIdentificationclone () throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
const Common::Types::CapeStringGetComponentName () const throw (Common::Error::ECapeUnknown)
void SetComponentName (const Common::Types::CapeString &_name) throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
const Common::Types::CapeStringGetComponentDescription () 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::CapePointer DefaultValue () const throw (Common::Error::ECapeUnknown)
Common::Types::CapeBoolean Validate (Common::Types::CapePointer 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::CapePointer defaultValue
 parameter default value

Detailed Description

Diana realization of the ICapePointerParameterSpec interface.


Constructor & Destructor Documentation

Constructor.


Member Function Documentation

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

Reimplemented from ICapeIdentification.

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

Implements ICapePointerParameterSpec.

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.

gets the description of the component.

Implements ICapeIdentification.

gets the name of the component.

Implements ICapeIdentification.

sets the description of the component.

Parameters:
_descriptionthe description of the component

Implements ICapeIdentification.

sets the name of the component.

Parameters:
_namethe name of the component

Implements ICapeIdentification.

Returns void type (CAPE_VOID).

Implements ICapeParameterSpec.

Validates a void 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:
valuethe value of the parameter to validate
messagemessage conveying information regarding the validation

Implements ICapePointerParameterSpec.


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