#include <CapeParameter.hpp>
Public Member Functions | |
| virtual Common::Types::CapeVariant | GetValue ()=0 throw (Common::Error::ECapeUnknown) |
| virtual void | SetValue (const Common::Types::CapeVariant &_value)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) |
| virtual Common::Types::CapeValidationStatus | ValStatus () const =0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) |
| virtual CapeParamMode | GetMode () const =0 throw (Common::Error::ECapeUnknown) |
| virtual void | SetMode (CapeParamMode _mode)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) |
| virtual ICapeParameterSpec * | Specification () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeBoolean | Validate (Common::Types::CapeString &message)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) |
| virtual void | Reset ()=0 throw (Common::Error::ECapeUnknown) |
Friends | |
| std::ostream & | operator<< (std::ostream &os, ICapeParameter ¶m) |
Detailed Description
Defines Cape Open parameter definition.
Member Function Documentation
| virtual CapeParamMode GetMode | ( | ) | const throw (Common::Error::ECapeUnknown) [pure 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.
Implemented in DianaParameter.
| virtual Common::Types::CapeVariant GetValue | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the value of this parameter. Passed as a CapeVariant that should be the same type as the Parameter type.
Implemented in DianaParameter.
Referenced by SingAnalyser::addDerivativeByParameter(), DianaContinuation::addDerivativeByParameter(), DianaContinuation::DianaContinuation(), and DianaContinuation::packFreeParameters().
| virtual void Reset | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Sets the value of the parameter to its default value.
Implemented in DianaParameter.
| virtual void SetMode | ( | CapeParamMode | _mode | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [pure 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
Implemented in DianaParameter.
| virtual void SetValue | ( | const Common::Types::CapeVariant & | _value | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument) [pure 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.
Implemented in DianaParameter, IDianaPetriPlace, and PetriPlace.
Referenced by SingAnalyser::addDerivativeByParameter(), DianaContinuation::addDerivativeByParameter(), and DianaContinuation::unpackFreeParameters().
| virtual ICapeParameterSpec* Specification | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the specification of the parameter. The Get method returns the specification as an interface to the correct specification type.
Implemented in DianaParameter.
Referenced by DianaContinuation::getParameterBoundaries().
| virtual Common::Types::CapeBoolean Validate | ( | Common::Types::CapeString & | message | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [pure 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
Implemented in DianaParameter.
| virtual Common::Types::CapeValidationStatus ValStatus | ( | ) | const throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [pure 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.
Implemented in DianaParameter.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | os, |
| ICapeParameter & | param | ||
| ) | [friend] |
ostream output operator for the ICapeParameter class.
The documentation for this class was generated from the following file:
