All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATIValue
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIValue
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIValue
Interface dedicated to the management of values.
Method Index
- o
AsBoolean(boolean&)
- Converts the value to a boolean (for boolean values only).
- o
AsInteger(int&)
- Converts the value to an integer.
- o
AsObject(CATBaseUnknown_var&)
- Converts the value to an object reference (useful for complex values).
- o
AsReal(double&)
- Converts the value to a double.
- o
AsString(CATUnicodeString&)
- Converts the value to a string.
- o
Compare(CATIValue_var&)
- Compares two values (taking tolerance into account for numerical values).
- o
GetConst()
- Returns the constantness of the value.
- o
GetIsSet()
- Returns the status of the value.
- o
GetReadOnly()
- Returns the writability of the value.
- o
SetConst(boolean)
- Sets the constantness of the value.
- o
SetReadOnly(boolean)
- Sets the writability of the value.
- o
Show()
- Returns a string showing the value (example : "3mm").
- o
Unset()
- Unsets the value.
Methods
o AsBoolean
public virtual HRESULT AsBoolean( | boolean& | oValue) const =0 |
-
Converts the value to a boolean (for boolean values only).
o AsInteger
public virtual HRESULT AsInteger( | int& | oValue) const =0 |
-
Converts the value to an integer.
For enum values (including booleans), it returns the rank.
For real values, it converts their value to the nearest lower integer.
o AsObject
-
Converts the value to an object reference (useful for complex values).
o AsReal
public virtual HRESULT AsReal( | double& | oValue) const =0 |
-
Converts the value to a double.
For enum values (including booleans), it returns the rank.
For dimensions, it returns their value in MKS system !
o AsString
-
Converts the value to a string.
For enum types (including booleans), it returns the string corresponding to the rank.
o Compare
public virtual boolean Compare( | const CATIValue_var& | iValue) const = 0 |
-
Compares two values (taking tolerance into account for numerical values).
- Parameters:
-
- iValue
- Value to be compared to the current one.
- Returns:
- TRUE if equal, else FALSE.
o GetConst
public virtual boolean GetConst( | )const = 0 |
-
Returns the constantness of the value.
- Returns:
- TRUE if constant, else FALSE.
o GetIsSet
public virtual boolean GetIsSet( | )const = 0 |
-
Returns the status of the value.
- Returns:
- TRUE if the value is set, else FALSE.
o GetReadOnly
public virtual boolean GetReadOnly( | )const = 0 |
-
Returns the writability of the value.
- Returns:
- TRUE is read-only, else FALSE.
o SetConst
public virtual void SetConst( | const boolean | iConst) = 0 |
-
Sets the constantness of the value.
- Parameters:
-
- iConst
- TRUE to set to constant, else FALSE.
o SetReadOnly
public virtual void SetReadOnly( | const boolean | iReadOnly)= 0 |
-
Sets the writability of the value.
- Parameters:
-
- iReadOnly
- TRUE to set read-only, FALSE to set the value writable.
o Show
-
Returns a string showing the value (example : "3mm").
- Returns:
- a string.
o Unset
public virtual void Unset( | )= 0 |
-
Unsets the value.
This object is included in the file: CATIValue.h
If needed, your Imakefile.mk should include the module: KnowledgeItf