All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectSpecsModeler Interface CATICatalog

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATICatalog
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATICatalog

Interface to manage StartUp in this catalog.
Role: all the start ups have to be created in catalogs only.
Usage : Creation / Retrieval of a StartUp in a catalog
WARNINGS :

See also:
CATOsmSUHandler


Method Index


o CreateSUInCatalog(CATBaseUnknown**,CATUnicodeString*,CATUnicodeString*,char*,CATUnicodeString*,CATBoolean,CATBoolean)
Creates a SartUp.
o OpenPrereqCatalog(CATUnicodeString*,CATUnicodeString*)
Opens a Catalog.
o RetrieveSU(CATBaseUnknown**,CATUnicodeString*,char*)
Retrieves a SartUp.
o SetClientId(CATUnicodeString*)
Sets client Identifier.

Methods


o CreateSUInCatalog
public virtual HRESULT CreateSUInCatalog(CATBaseUnknown** oStartUp,
const CATUnicodeString* iName,
const CATUnicodeString* iType,
const char* iIntfName,
const CATUnicodeString* iSuperType= NULL,
CATBoolean iPublic=FALSE,
CATBoolean iDerivable=FALSE) = 0
Creates a SartUp.
Parameters:
oStartUp
The new StartUp created.
iName
The name of the new StartUp to create.
iType
The type of the new StartUp to create.
iIntfName
The name of the interface that will handle the new StartUp.
iSuperType
The super-type of the new StartUp to create. The new StartUp will be derived from the StartUp having this type.
iPublic
TRUE if the new StartUp is "public": a new entry is created in the corresponding .CATSpecs file.
FALSE if the new StartUp is "private".
iDerivable
TRUE if other StartUps are allowed to derive from this one.
FALSE otherwise.
Returns:
E_FAIL for catalogs that are not of type "CATfct" and if the "ClientId" has not been set.
o OpenPrereqCatalog
public virtual HRESULT OpenPrereqCatalog( const CATUnicodeString* iStorageName,
const CATUnicodeString* iClientId) = 0
Opens a Catalog.
Parameters:
iStorageName
The name and .CATfct extension of the catalog being opened. The catalog must be found under the current "WS" + "OS" + resources + graphic directory.
iClientId
The catalog's client identifier.
Returns:
E_FAIL for failed open operation or for wrong client identifier
o RetrieveSU
public virtual HRESULT RetrieveSU(CATBaseUnknown** oStartUp,
const CATUnicodeString* iType,
const char* iIntfName) = 0
Retrieves a SartUp.
Parameters:
oStartUp
The StartUp retrieved.
iType
The type of the StartUp to be retrieved.
iIntfName
The name of the interface that will handle the retrieved StartUp.
Returns:
S_OK if StartUp of the given type is found; E_FAIL otherwise.
o SetClientId
public virtual HRESULT SetClientId( const CATUnicodeString* iClientId) = 0
Sets client Identifier.
Parameters:
iClientId
The unique client id that will henceforward identify the catalog.

This object is included in the file: CATICatalog.h
If needed, your Imakefile.mk should include the module: CATObjectSpecsModeler

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