All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATIParmDictionary
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIParmDictionary
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIParmDictionary
Interface to manage the dictionary of types.
Role: It gathers static methods to parameters type dictionary management.
It offers direct access to common literals types and methods to find magnitudes and units by name
It gives a way to create your own functions that can later be used in relations, and add them
to the dictionary
It gives a way to add own applications that can later be used in applications dialog in the
knowledgeware workbench
- See also:
- CATIAddLibrary
- See also:
- CATICkeType
- See also:
- CATICkeMagnitude
- See also:
- CATICkeUnit
Method Index
- o
AddType(CATICkeType_var&)
- Adds a type to the dictionnary.
- o
CreateType(char*,CATICkeType_var&,CATUnicodeString&)
- Creates a C++ type (or find it if already exists) and add it to dictionary.
- o
FindMagnitude(CATUnicodeString&)
- Finds a magnitude from its coded name.
- o
FindType(char*)
- Finds a type by its coded name.
- o
FindUnit(CATUnicodeString&)
- Finds a unit from its coded name.
- o
FindUnitFromSymbol(CATUnicodeString&)
- Finds a unit from its symbol.
- o
GetAngleType()
- Returns the Angle type.
- o
GetBooleanType()
- Returns the Boolean type.
- o
GetDimensionType()
- Returns the Dimension type.
- o
GetEnumType()
- Returns the Enum type.
- o
GetFeatureType()
- Returns the Feature type: main basic class for feature references.
- o
GetIntegerType()
- Returns the Integer type.
- o
GetLengthType()
- Returns the Length type.
- o
GetListType()
- Returns the type for lists.
- o
GetLiteralType()
- Returns the basic type for any literal (simple value).
- o
GetRealType()
- Returns the Real type.
- o
GetStringType()
- Returns the String type.
- o
GetVoidType()
- Returns the Void type.
- o
GetVolatileFactory()
- Returns the volatile factory.
- o
LoadLibrary(char*)
- Asks to load a library by its name.
- o
Magnitudes(CATCkeListOfMagnitude)
- Returns the list of all magntitudes contained in the parameter dictionary.
- o
RemoveType(CATICkeType_var&)
- Removes a type to the dictionnary.
Methods
o AddType
public virtual void AddType( | const CATICkeType_var& | iType)=0 |
-
Adds a type to the dictionnary.
- Parameters:
-
- iType:
- type to add
o CreateType
-
Creates a C++ type (or find it if already exists) and add it to dictionary.
- Parameters:
-
- iCodedName
- : name of type to create
- iFatherType:
- father type if any
- iNLSName
- : NLS name for the type if any
- Returns:
- CATICkeType_var : type found or created
o FindMagnitude
-
Finds a magnitude from its coded name.
o FindType
-
Finds a type by its coded name.
- Parameters:
-
- iCodedName
- : name of type to find
o FindUnit
-
Finds a unit from its coded name.
o FindUnitFromSymbol
-
Finds a unit from its symbol.
- Parameters:
-
- symbol
- the string containing the symbol (eg. "mm" or "m3").
The empty string argument "" is not valid.
- Returns:
- the unit (NULL_var if the unit wasn't found)
o GetAngleType
-
Returns the Angle type.
o GetBooleanType
-
Returns the Boolean type.
o GetDimensionType
-
Returns the Dimension type.
o GetEnumType
-
Returns the Enum type.
o GetFeatureType
-
Returns the Feature type: main basic class for feature references.
o GetIntegerType
-
Returns the Integer type.
o GetLengthType
-
Returns the Length type.
o GetListType
-
Returns the type for lists.
o GetLiteralType
-
Returns the basic type for any literal (simple value).
o GetRealType
-
Returns the Real type.
o GetStringType
-
Returns the String type.
o GetVoidType
-
Returns the Void type.
o GetVolatileFactory
-
Returns the volatile factory.
o LoadLibrary
public virtual CATCke::Boolean LoadLibrary( | const char* | iLibraryName)=0 |
-
Asks to load a library by its name.
- Parameters:
-
- iLibraryName:
- C++ class name of the library
- Returns:
- : CATCke::True if succeeded
o Magnitudes
-
Returns the list of all magntitudes contained in the parameter dictionary.
- Parameters:
-
- ioListOfMagnitudes:
- a pointer to an empty list of magnitudes.
o RemoveType
public virtual void RemoveType( | const CATICkeType_var& | iType)=0 |
-
Removes a type to the dictionnary.
- Parameters:
-
- iType:
- type to remove : USE WITH CARE
This object is included in the file: CATIParmDictionary.h
If needed, your Imakefile.mk should include the module: KnowledgeItf