#include <CapeParameter.hpp>
Inheritance diagram for ICapeBooleanParameterSpec:
Public Member Functions | |
| virtual Common::Types::CapeBoolean | DefaultValue () const =0 throw (Common::Error::ECapeUnknown) |
| virtual Common::Types::CapeBoolean | Validate (Common::Types::CapeBoolean value, Common::Types::CapeString &message)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) |
Friends | |
| std::ostream & | operator<< (std::ostream &os, const ICapeBooleanParameterSpec &pspec) |
Detailed Description
Boolean parameter specification. Specification defines default value.
Member Function Documentation
| virtual Common::Types::CapeBoolean DefaultValue | ( | ) | const throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the default value of the boolean valued parameter for which this is the specification.
Implemented in DianaBooleanParameterSpec.
| virtual Common::Types::CapeBoolean Validate | ( | Common::Types::CapeBoolean | value, |
| Common::Types::CapeString & | message | ||
| ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [pure virtual] |
Validates a boolean 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 DianaBooleanParameterSpec.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | os, |
| const ICapeBooleanParameterSpec & | pspec | ||
| ) | [friend] |
ostream output operator for the ICapeBooleanParameterSpec class.
The documentation for this class was generated from the following file:
