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 the management of parameters (to read its content).
A parameter may be a literal, a volatile value, a list feature or a volatile list, a geometric datum, or a reference to V5 object.
Interface similar to CATIValue. But it is not implemented on objects that implements CATICkeParm.
Such an interface is returned by method.
This interface is multi implemented.
- See also:
- ,
Method Index
- o
AsBoolean()
- Converts the content to a boolean (for boolean values only).
- o
AsDate()
- Converts the content to a CATTime date (for date values only).
- o
AsInteger()
- Converts the content to an integer.
- o
AsObject()
- Converts the value to an object reference.
- o
AsReal()
- Converts the content to a double.
- o
AsStored()
- Returns value as it is stored in the model.
- o
AsString()
- Converts the content to a string.
- o
Compare(CATICkeInst_var&)
- Compares two parameters from their content.
- o
Show()
- Returns way of seeing the content of a parameter.
- o
Type()
- Returns the type of the parameter.
Methods
o AsBoolean
| public virtual AsBoolean( | ) |
-
Converts the content to a boolean (for boolean values only).
- Returns:
- the value converted as a boolean
o AsDate
-
Converts the content to a CATTime date (for date values only).
- Returns:
- the value converted as a CATTime
o AsInteger
| public virtual AsInteger( | ) |
-
Converts the content to an integer.
enum values (including booleans) returns rank
real values returns their value converted in integer
integer values return value
- Returns:
- the value converted as an integer
o AsObject
| public virtual AsObject( | ) |
-
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.
- Returns:
- the value converted as an object
o AsReal
-
Converts the content to a double.
enum values (including booleans) returns rank
real values and integer return their value
dimensions return their value IN SI units !!!!!
- Returns:
- the value converted as a real value
o AsStored
| public virtual AsStored( | ) |
-
Returns value as it is stored in the model.
Only for dimensions values.
- Returns:
- the value converted as a double, as stored in the model
o AsString
| public virtual AsString( | ) |
-
Converts the content to a string.
string values return their value
enum types (including booleans) values return their value
- Returns:
- the value converted as a string
o Compare
| public virtual Compare( | const | iValue) |
-
Compares two parameters 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 the content of a parameter. To be used when showing a content to a end-user.
(example : "3mm").
o Type
-
Returns the type of the parameter.
(example : Integer, Angle, etc...)
This object is included in the file: CATICkeInst.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.