All Frameworks Class Hierarchy This Framework Indexes
KnowledgeInterfaces Interface CATICkeInst
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICkeInst
Interface dedicated to parameters value management such as convertion from units to simple types and comparison of values.
Role: A parameter value is a union between simple types of values. This class presents a sets of methods
that enable the convertion between parameter values and simple types.
(integer, double, boolean, and CATUnicodeString)
- See also:
- CATICkeParm, CATICkeType
Method Index
- o
AsBoolean()
- Converts the value to a boolean (for boolean values only).
- o
AsInteger()
- Converts the value to an integer.
- o
AsObject()
- Converts the value to an object reference.
- o
AsReal()
- Converts the value to a double.
- o
AsStored()
- Returns value as it is stored in the model.
- o
AsString()
- Converts the value to a string.
- o
Compare(CATICkeInst_var&)
- Compares two values from their content.
- o
Show()
- Returns way of seeing a value.
- o
Type()
- Returns the type of the value.
Methods
o AsBoolean
| public virtual AsBoolean( | ) |
-
Converts the value to a boolean (for boolean values only).
o AsInteger
| public virtual AsInteger( | ) |
-
Converts the value to an integer.
enum values (including booleans) returns rank
real values returns their value converted in integer
integer values return value
o AsObject
| public virtual AsObject( | ) |
-
Converts the value to an object reference.
o AsReal
-
Converts the value to a double.
enum values (including booleans) returns rank
real values and integer return their value
dimensions return their value IN SI units !!!!!
o AsStored
| public virtual AsStored( | ) |
-
Returns value as it is stored in the model.
o AsString
| public virtual AsString( | ) |
-
Converts the value to a string.
string values return their value
enum types (including booleans) values return their value
o Compare
| public virtual Compare( | const | iValue) |
-
Compares two values from their content.
(taking tolerance (epsilon) into account
- Parameters:
-
- iValue
- value to be compared
- Returns:
- Legal values: CATCke::True if comparison Ok.
CATCke::False if comparison Ko.
o Show
-
Returns way of seeing a value.
(example : "3mm").
o Type
-
Returns the type of the value.
(example : Integer, Angle, etc...)
This object is included in the file: CATICkeInst.h
If needed, your Imakefile.mk should include the module: KnowledgeItf