All Frameworks  Class Hierarchy  This Framework  Indexes   

KnowledgeInterfaces Interface 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 AsBoolean( oValue)
Converts the value to a boolean (for boolean values only).
o AsInteger
public virtual AsInteger( oValue)
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
public virtual AsObject( oValue)
Converts the value to an object reference (useful for complex values).
o AsReal
public virtual AsReal( oValue)
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
public virtual AsString( oValue)
Converts the value to a string. For enum types (including booleans), it returns the string corresponding to the rank.
o Compare
public virtual Compare( const iValue)
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 GetConst()
Returns the constantness of the value.
Returns:
TRUE if constant, else FALSE.
o GetIsSet
public virtual GetIsSet()
Returns the status of the value.
Returns:
TRUE if the value is set, else FALSE.
o GetReadOnly
public virtual GetReadOnly()
Returns the writability of the value.
Returns:
TRUE is read-only, else FALSE.
o SetConst
public virtual SetConst( const iConst)
Sets the constantness of the value.
Parameters:
iConst
TRUE to set to constant, else FALSE.
o SetReadOnly
public virtual SetReadOnly( const iReadOnly)
Sets the writability of the value.
Parameters:
iReadOnly
TRUE to set read-only, FALSE to set the value writable.
o Show
public virtual Show()
Returns a string showing the value (example : "3mm").
Returns:
a string.
o Unset
public virtual Unset()
Unsets the value.

This object is included in the file: CATIValue.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

Copyright © 2003, Dassault Systèmes. All rights reserved.