Diana
0.8.3
|
#include <DianaParameter.hpp>
Public Member Functions | |
DianaPointerParameterSpec (const Common::Types::CapeString &name, const Common::Types::CapeString &description=Common::Types::CapeStringUNDEFINED, Common::Types::CapePointer _defaultValue=NULL) | |
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::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 |
Diana realization of the ICapePointerParameterSpec interface.
DianaPointerParameterSpec | ( | const Common::Types::CapeString & | name, |
const Common::Types::CapeString & | description = Common::Types::CapeStringUNDEFINED , |
||
Common::Types::CapePointer | _defaultValue = NULL |
||
) |
Constructor.
Common::Identification::ICapeIdentification* clone | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [virtual] |
Creates a new copy in the memory of the DianaPointerParameterSpec object.
Reimplemented from ICapeIdentification.
Common::Types::CapePointer DefaultValue | ( | ) | const throw (Common::Error::ECapeUnknown) [virtual] |
Gets the default value of the void valued parameter for which this is the specification.
Implements ICapePointerParameterSpec.
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.
_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.
_name | the name of the component |
Implements ICapeIdentification.
Common::Parameter::CapeParamType Type | ( | ) | const throw (Common::Error::ECapeUnknown) [virtual] |
Returns void type (CAPE_VOID).
Implements ICapeParameterSpec.
Common::Types::CapeBoolean Validate | ( | Common::Types::CapePointer | value, |
Common::Types::CapeString & | message | ||
) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [virtual] |
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.
value | the value of the parameter to validate |
message | message conveying information regarding the validation |
Implements ICapePointerParameterSpec.