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 parameters (to read its content).
Interface similar to CATICkeInst.
This interface is multi implemented on literal, volatile values, list feature and volatile list, geometric datum, and reference to V5 object.
Those objects also implement CATICkeParm
- See also:
- ,
Method Index
- o
AsBoolean()
- Converts the content to a boolean.
- o
AsBoolean(boolean&)
- Converts the content to a boolean (for boolean values only).
- o
AsDate()
- Converts the content to a CATTime date (for date values only).
- o
AsDate(CATTime&)
- Return the content as a CATTime date (for date values only).
- o
AsInteger()
- Converts the content to an integer.
- o
AsInteger(int&)
- Converts the content to an integer.
- o
AsObject()
- Converts the content to an object reference.
- o
AsObject(CATBaseUnknown_var&)
- Converts the value to an object reference.
- o
AsReal()
- Converts the content to a double.
- o
AsReal(double&)
- Converts the content to a double.
- o
AsString()
- Converts the content to a string.
- o
AsString(CATUnicodeString&)
- Converts the content to a string.
- o
Compare(CATIValue_var&)
- Compares two values (taking tolerance into account for numerical values).
- o
GetConst()
- Returns the constantness of the content.
- o
GetIsSet()
- Returns the status of the content.
- o
GetReadOnly()
- Returns the writability of the content.
- o
SetConst(boolean)
- Sets the constantness of the content.
- o
SetReadOnly(boolean)
- Sets the writability of the content.
- o
Show()
- Returns a string showing the content (example : "3mm").
- o
Unset()
- Unsets the content.
Methods
o AsBoolean
| public virtual AsBoolean( | ) |
-
Converts the content to a boolean.
for boolean values only.
- Returns:
- value converted as a string
o AsBoolean
| public virtual AsBoolean( | | oValue) |
-
Converts the content to a boolean (for boolean values only).
for boolean values only.
- Parameters:
-
- oValue
- value converted as a boolean
- Returns:
- classic HRESULT
o AsDate
-
Converts the content to a CATTime date (for date values only).
- Returns:
- value value as a date
o AsDate
| public virtual AsDate( | | oValue) |
-
Return the content as a CATTime date (for date values only).
- Parameters:
-
- oValue
- value as a date
- Returns:
- classic HRESULT
o AsInteger
| public virtual AsInteger( | ) |
-
Converts the content to an integer.
Works on integer values.
For enum values (including booleans), it returns the rank.
For real values, it converts their value to the nearest lower integer.
- Returns:
- value converted as an integer
o AsInteger
| public virtual AsInteger( | | oValue) |
-
Converts the content to an integer.
Works on integer values.
For enum values (including booleans), it returns the rank.
For real values, it converts their value to the nearest lower integer.
- Parameters:
-
- oValue
- value converted as an integer
- Returns:
- classic HRESULT
o AsObject
| public virtual AsObject( | ) |
-
Converts the content to an object reference.
Works for reference to V5 objects: returns the object.
Works also for lists: returns the list object.
Works for geometric datum: returns the geometric datum itself.
- Returns:
- value converted as an object
o AsObject
| public virtual AsObject( | | oValue) |
-
Converts the value to an object reference.
Works for reference to V5 objects: returns the object.
Works also for lists: returns the list object.
Works for geometric datum: returns the geometric datum itself.
- Parameters:
-
- oValue
- value converted as an object
- Returns:
- classic HRESULT
o AsReal
-
Converts the content to a double.
Works on real values.
For enum values (including booleans), it returns the rank.
For dimensions, it returns their value in MKS system !
- Returns:
- value converted as a real
o AsReal
| public virtual AsReal( | | oValue) |
-
Converts the content to a double.
Works on real values.
For enum values (including booleans), it returns the rank.
For dimensions, it returns their value in MKS system !
- Parameters:
-
- oValue
- value converted as an integer
- Returns:
- classic HRESULT
o AsString
| public virtual AsString( | ) |
-
Converts the content to a string.
Works on string values.
For enum types (including booleans), it returns the string corresponding to the rank.
- Returns:
- value converted as a string
o AsString
| public virtual AsString( | | oValue) |
-
Converts the content to a string.
Works on string values.
For enum types (including booleans), it returns the string corresponding to the rank.
- Parameters:
-
- oValue
- value converted as a string
- Returns:
- classic HRESULT
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 content.
- Returns:
- TRUE if constant, else FALSE.
o GetIsSet
| public virtual GetIsSet( | ) |
-
Returns the status of the content.
- Returns:
- TRUE if the content is set, else FALSE.
o GetReadOnly
| public virtual GetReadOnly( | ) |
-
Returns the writability of the content.
- Returns:
- TRUE is read-only, else FALSE.
o SetConst
| public virtual SetConst( | const | iConst) |
-
Sets the constantness of the content.
- Parameters:
-
- iConst
- TRUE to set to constant, else FALSE.
o SetReadOnly
| public virtual SetReadOnly( | const | iReadOnly) |
-
Sets the writability of the content.
- Parameters:
-
- iReadOnly
- TRUE to set read-only, FALSE to set the value writable.
o Show
-
Returns a string showing the content (example : "3mm").
- Returns:
- a string.
o Unset
-
Unsets the content.
This object is included in the file: CATIValue.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.