All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATICkeInst

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 CATCke::Boolean AsBoolean()const =0
Converts the value to a boolean (for boolean values only).
o AsInteger
public virtual int AsInteger()const =0
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 CATBaseUnknown_var AsObject()const =0
Converts the value to an object reference.
o AsReal
public virtual double AsReal()const =0
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 double AsStored()const =0
Returns value as it is stored in the model.
o AsString
public virtual CATUnicodeString AsString()const =0
Converts the value to a string.
string values return their value
enum types (including booleans) values return their value
o Compare
public virtual CATCke::Boolean Compare( const CATICkeInst_var& iValue) const = 0
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
public virtual CATUnicodeString Show()const =0
Returns way of seeing a value. (example : "3mm").
o Type
public virtual CATICkeType_var Type()const =0
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

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