All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamDocumentManager

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

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


interface CATISamDocumentManager

Interface to link a CATAnalysis Document with another document.
Role:Interface designed to manage links to external document such as .CATPart,.CATProduct,CATIA model,,etc... .
This links will be created at the level of the Links manager Object.


Method Index


o GetDocument(CATISpecObject*,CATDocument*&,int)
Retrieves the pointed document fom an external links of a CATAnalysis.
o GetPointedDocuments(CATLISTP(CATDocument)&)
Retrieves all the external links from the CATAnalysis.
o GetPointingLinks(CATLISTV(CATISpecObject_var)&)
Retrieves all the external links from the CATAnalysis.
o InsertDocument(CATDocument*,CATString,CATISpecObject*,int)
Adds a external link from the Document manager to an external document.
o InsertDocument(CATIDocId*,CATString,CATISpecObject*,int)
Adds a external link from the Document manager to an external document.
o RemoveDocument(CATDocument*)
Removes a external link from the Document manager to an external document.

Methods


o GetDocument
public virtual HRESULT GetDocument( const CATISpecObject* iSpec,
CATDocument*& opDoc,
const int iForceLoad=0) = 0
Retrieves the pointed document fom an external links of a CATAnalysis.
Parameters:
iSpec
The CATISpecObject use to link an external document.
opDoc
The CATDocument that is linked.
iLoad

Legal values:
  • 1: Force the loading of the document.
  • 0: Do not load the pointed document.
o GetPointedDocuments
public virtual HRESULT GetPointedDocuments(CATLISTP(CATDocument)& oList) = 0
Retrieves all the external links from the CATAnalysis.
Parameters:
oList
The collection of CATDocument pointed by .CATAnalysis document.
See also:
CATDocument
o GetPointingLinks
public virtual HRESULT GetPointingLinks(CATLISTV(CATISpecObject_var)& oList) = 0
Retrieves all the external links from the CATAnalysis.
Parameters:
oList
The collection of CATISpecObject pointed by .CATAnalysis document.
o InsertDocument
public virtual HRESULT InsertDocument( const CATDocument* iDocumentToAdd,
CATString iLinkType= "SAMLink",
CATISpecObject* iFeatureLink= NULL ,
const int iTypeLink=0) = 0
Adds a external link from the Document manager to an external document.
Parameters:
iDocumentToAdd
The document to be linked.
iLinkType
The document type (Extension).
iFeatureLink
Optional if a specific feature is required for the link.
This feature may be created by derivation of the SAMFeatureLink startup. If not valuated, a default "SAMFeatureLink" will be created.
iTypeLink
Optional: Allow to specify a link behavoir for SMARTeam integration for a For non CATIA Document.
Legal values:
  • 1: will customize an output link (Result attached to an Analysis).
  • 0: will customize an input link (Import of data inside V5). This is the default value.
o InsertDocument
public virtual HRESULT InsertDocument( const CATIDocId* iDocIDToAdd,
CATString iLinkType= "SAMLink",
CATISpecObject* iFeatureLink= NULL ,
const int iTypeLink=0) = 0
Adds a external link from the Document manager to an external document.
Parameters:
iDocIDToAdd
The documentID to be linked.
iLinkType
The document type (Extension).
iFeatureLink
Optional if a specific feature is required for the link.
This feature may be created by derivation of the SAMFeatureLink startup. If not valuated, a default "SAMFeatureLink" will be created.
iTypeLink
Optional: Allow to specify a link behavoir for SMARTeam integration for a For non CATIA Document.
Legal values:
  • 1: will customize an output link (Result attached to an Analysis).
  • 0: will customize an input link (Import of data inside V5). This is the default value.
o RemoveDocument
public virtual HRESULT RemoveDocument( const CATDocument* iDocumentToRemove) = 0
Removes a external link from the Document manager to an external document.
Parameters:
iDocumentToRemove
The document to be unlinked.

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

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