All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Class CATDocument

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---ObjectModelerBase.CATImplementationAdapter
          |
          +---ObjectModelerBase.CATObject
            |
            +---CATDocument
 

Usage: you must use this class as is. You should never derive it.


public class CATDocument

Class to contain the data of your model.
Role:This class represents the document. But main methods to handle a document are found in interfaces such as: CATInit, CATIEditor, CATIDocAlias ....
To open, save,retrieve a document see the methods defined in CATDocumentServices (in batch mode) or the interface CATIIniInteractiveSession found in InteractiveInterfaces Framework (in interactive mode).
The life cycle of a document is explained in CATDocumentServices.


Method Index


o DisplayName()
Returns the display name of the document.
o GetDocId(CATIDocId**)
Retrieves the document identification element.
o StorageName()
Returns the complete access name of the document.

Methods


o DisplayName
public CATUnicodeString DisplayName()const
Returns the display name of the document.
Note:The display name might be different from storage name (as storage name might be meaningless for user)
For instance it could be just the name of the document, not the whole path (environment are dealing with meaningfull user name)
o GetDocId
public HRESULT GetDocId(CATIDocId** oDocId)
Retrieves the document identification element.
Note:The document identification element contains three information: document environment + document type + document identifier. See CATIDocId.
Parameters:
oDocId
The document identification element.
Returns:
S_OK: the CATIDocId has been retrieved successfully.
E_FAIL: the operation failed.
o StorageName
public CATUnicodeString StorageName()const
Returns the complete access name of the document.
Note:The complete access name is: path + name of the document + suffix where:
The suffix is dedicated to the document's type (CATPart, CATProduct, ...).
In interactive mode, the name of the document is displayed in the document's window.
The path is the complete path of the directory which contains the file.

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

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