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
public virtual CATICkeType_var CreateType( const char* iCodedName,
const CATICkeType_var& iFatherType= NULL_var,
const CATUnicodeString& iNLSName= "")=0
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
public virtual CATICkeMagnitude_var FindMagnitude( const CATUnicodeString& s)=0
Finds a magnitude from its coded name.
o FindType
public virtual CATICkeType_var FindType( const char* iCodedName)=0
Finds a type by its coded name.
Parameters:
iCodedName
: name of type to find
o FindUnit
public virtual CATICkeUnit_var FindUnit( const CATUnicodeString& s)=0
Finds a unit from its coded name.
o FindUnitFromSymbol
public virtual CATICkeUnit_var FindUnitFromSymbol( const CATUnicodeString& symbol)=0
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 CATICkeType_var GetAngleType()=0
Returns the Angle type.
o GetBooleanType
public virtual CATICkeType_var GetBooleanType()=0
Returns the Boolean type.
o GetDimensionType
public virtual CATICkeType_var GetDimensionType()=0
Returns the Dimension type.
o GetEnumType
public virtual CATICkeType_var GetEnumType()=0
Returns the Enum type.
o GetFeatureType
public virtual CATICkeType_var GetFeatureType()=0
Returns the Feature type: main basic class for feature references.
o GetIntegerType
public virtual CATICkeType_var GetIntegerType()=0
Returns the Integer type.
o GetLengthType
public virtual CATICkeType_var GetLengthType()=0
Returns the Length type.
o GetListType
public virtual CATICkeType_var GetListType()=0
Returns the type for lists.
o GetLiteralType
public virtual CATICkeType_var GetLiteralType()=0
Returns the basic type for any literal (simple value).
o GetRealType
public virtual CATICkeType_var GetRealType()=0
Returns the Real type.
o GetStringType
public virtual CATICkeType_var GetStringType()=0
Returns the String type.
o GetVoidType
public virtual CATICkeType_var GetVoidType()=0
Returns the Void type.
o GetVolatileFactory
public virtual CATICkeParmFactory_var GetVolatileFactory()=0
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
public virtual void Magnitudes(CATCkeListOfMagnitude ioListOfMagnitudes)=0
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

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