KnowledgeInterfaces Interface 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 of values.
Role: It gathers static methods to value type dictionary management.
It offers direct access to common types of values and it provides methods to find magnitudes and units by name.
- See also:
- , , ,
Method Index
- o
CloseUnits()
- Delete the dictionary of units.
- o
FindMagnitude(CATUnicodeString&)
- Finds a magnitude from its internal coded name.
- o
FindType(char*)
- Finds a value 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
GetDateType()
- Returns the type for dates.
- o
GetDimensionType()
- Returns the Dimension type, which is the basic type for all magnitudes.
- o
GetEnumType()
- Returns the Enum type, which is the basic type for all enumerated types of values.
- o
GetFeatureType()
- Returns the Feature type: main basic type for objects that can be manipulated by Knowledgeware.
- 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 (used for defining arguments of functions or expressions).
- o
GetVolatileFactory()
- Use CATCkeGlobalFunctions instead.
- o
Magnitudes(CATCkeListOfMagnitude)
- Returns the list of all magntitudes contained in the value type dictionary.
Methods
o CloseUnits
| public virtual CloseUnits( | ) |
-
Delete the dictionary of units.
o FindMagnitude
| public virtual FindMagnitude( | const | iName) |
-
Finds a magnitude from its internal coded name.
- Parameters:
-
- iName
- name of the magnitude Unfortunately, there is no way to know the all list of coded name of magnitudes that exist for a V5 release.
- Returns:
- the magnitude found
o FindType
| public virtual FindType( | const | iCodedName) |
-
Finds a value type by its coded name.
Unfortunately, there is no way to know the all list of coded name of units that exist for a V5 release.
- Parameters:
-
- iCodedName
- : name of type to find
- Returns:
- the type found
o FindUnit
| public virtual FindUnit( | const | iName) |
-
Finds a unit from its coded name.
- Parameters:
-
- iName
- name of the unit Unfortunately, there is no way to know the all list of coded name of units that exist for a V5 release.
- Returns:
- the unit found
o FindUnitFromSymbol
| public virtual FindUnitFromSymbol( | const | symbol) |
-
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
| public virtual GetAngleType( | ) |
-
Returns the Angle type.
o GetBooleanType
| public virtual GetBooleanType( | ) |
-
Returns the Boolean type.
o GetDateType
| public virtual GetDateType( | ) |
-
Returns the type for dates.
o GetDimensionType
| public virtual GetDimensionType( | ) |
-
Returns the Dimension type, which is the basic type for all magnitudes.
o GetEnumType
| public virtual GetEnumType( | ) |
-
Returns the Enum type, which is the basic type for all enumerated types of values.
o GetFeatureType
| public virtual GetFeatureType( | ) |
-
Returns the Feature type: main basic type for objects that can be manipulated by Knowledgeware.
o GetIntegerType
| public virtual GetIntegerType( | ) |
-
Returns the Integer type.
o GetLengthType
| public virtual GetLengthType( | ) |
-
Returns the Length type.
o GetListType
| public virtual GetListType( | ) |
-
Returns the type for lists.
o GetLiteralType
| public virtual GetLiteralType( | ) |
-
Returns the basic type for any literal (simple value).
o GetRealType
| public virtual GetRealType( | ) |
-
Returns the Real type.
o GetStringType
| public virtual GetStringType( | ) |
-
Returns the String type.
o GetVoidType
| public virtual GetVoidType( | ) |
-
Returns the Void type (used for defining arguments of functions or expressions).
o GetVolatileFactory
| public virtual GetVolatileFactory( | ) |
-
Use CATCkeGlobalFunctions instead.
- Returns:
- the volatile factory.for values
o Magnitudes
| public virtual Magnitudes( | | ioListOfMagnitudes) |
-
Returns the list of all magntitudes contained in the value type dictionary.
- Parameters:
-
- ioListOfMagnitudes:
- a pointer to an empty list of magnitudes.
This object is included in the file: CATIParmDictionary.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.