#include <CapeParameter.hpp>
Public Member Functions | |
| virtual Common::Types::CapeLong | DefaultValue () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeLong | LowerBound () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeLong | UpperBound () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeBoolean | Validate (Common::Types::CapeLong value, Common::Types::CapeString &message)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) |
Friends | |
| std::ostream & | operator<< (std::ostream &os, const ICapeIntegerParameterSpec &pspec) |
Detailed Description
Integer parameter specification. Specification defines boundaries and default value.
Member Function Documentation
| virtual Common::Types::CapeLong DefaultValue | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the default value of the integer valued parameter for which this is the specification.
Implemented in DianaIntegerParameterSpec.
| virtual Common::Types::CapeLong LowerBound | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the lower bound of the integer valued parameter for which this is the specification.
Implemented in DianaIntegerParameterSpec.
| virtual Common::Types::CapeLong UpperBound | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the upper bound of the integer valued parameter for which this is the specification.
Implemented in DianaIntegerParameterSpec.
| virtual Common::Types::CapeBoolean Validate | ( | Common::Types::CapeLong | value, |
| Common::Types::CapeString & | message | ||
| ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [pure virtual] |
Validates a integer 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:
-
value the value of the parameter to validate message message conveying information regarding the validation
Implemented in DianaIntegerParameterSpec.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | os, |
| const ICapeIntegerParameterSpec & | pspec | ||
| ) | [friend] |
ostream output operator for the ICapeIntegerParameterSpec class.
The documentation for this class was generated from the following file:
