All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATxPDMSessionServices
Usage: you must use this class as is. You should never derive it.
public class CATxPDMSessionServices
Class for PDM services working on items loaded in session.
Role: This class is used for external File PDM system integration.
All the methods pre-requisites the PX1 license
public static HRESULT BreakAllExternalLinks( | CATIxPDMItem_var& | iPDMItem) |
Notice that this API is equivalent to Isolate button in Edit/Links panel.
Save is necessary after a break.
public static HRESULT CheckDesignRules( | const CATListOfCATString& | iListOfRulesToCheck, |
CATListValCATIxPDMItem_var*& | oItemsWithError, | |
CATIReporter*& | oReporter) |
public static HRESULT CheckFeatureCompatibility( | CATBaseUnknown* | iFirstFeature, |
CATBaseUnknown* | iSecondFeature) |
public static HRESULT FindNonImportedPublications( | const CATIxPDMItem_var& | iItemWithImportedPublications, |
CATBaseUnknown* | iDocumentInstanceWithPublications, | |
CATListOfCATUnicodeString** | oNonImportedPublications) |
public static HRESULT GetItemFromDocument( | const CATDocument* | iInputDocument, |
CATIxPDMItem_var& | oPDMItem) |
public static HRESULT GetItemFromFeature( | const CATBaseUnknown_var& | iInputFeature, |
CATIxPDMItem_var& | oPDMItem) |
public static HRESULT GetxPDMItemsInSession( | CATListValCATIxPDMItem_var*& | oListOfLoadedItem) |
public static HRESULT IsImported( | const CATIxPDMItem_var& | iItemWithImport, |
CATBaseUnknown* | ipRefObject, | |
CATBaseUnknown* | iDocumentInstance) |
public static HRESULT LoadItemInSession( | const CATIxPDMItem_var& | iItemToLoad, |
CATIxPDMItem_var& | oLoadedItem) |
public static HRESULT NeedToLaunchCATDUAForLinksAnalysis( | const CATIxPDMItem_var& | iItemToCheck, |
CATBoolean& | oNeedToLaunchCATDUA) |
If some rules are detected, it means that after CATDUA links status will be different. Some links will potentially disappears and ConsistentSet could be very different.
public static HRESULT RefreshItemInformation( | CATIxPDMItem_var& | iPDMItem, |
ItemRefresh& | iToRefresh) |
public static HRESULT SaveSessionToDirectory( | const char* | iDirectoryPath, | |
CATUnicodeString& | oErrorMessage, | ||
CATListValCATIxPDMItem_var* | iListItemToRename | =NULL, | |
CATListOfCATUnicodeString* | iListOfNewNames | =NULL) |
As soon as you work on several documents, you have to use this method instead of the SaveAs method of the CATDocumentServices class to keep link consistency especially when renaming documents.
Item is saved in the targeted directory only if:
This method allows also to export data coming from ENOVIA V5 or ENOVIA VPM V4 to a File directory.
Item not processed by this method:
This method performs a complete export if the targeted directory doesn't contain any of documents in session. This means that all items will be saved in the targeted directory even if they are not modified in session.
Notes
For other errors, same content as message associaded to returned error.
If an item of the directory is not added in this list, the used default name will be the CATIA display name.
If items are not file based, but VPM or ENOVIA items, you must fill up iListItemToRename and iListOfNewNames.
The size of iListDocToRename and iListOfNewNames must be exactly the same.
public static HRESULT SetExternalLinksStatus( | CATIxPDMItem_var& | iPDMItem, |
const CATBoolean | iActivated) |
Notice that only geometrical links support this activation notion. A deactivated link means that geometrical modifications are no more propagated through this link. The link still exists and is still taken into account in SendTo, CATxPDMFileServices.GetConsistentSet or CATxPDMFileServices.SearchRootItems .
Notice that this API is equivalent to Activate/Deactivate buttons in Edit/Links panel.
Save is necessary after a link status modification.
public static HRESULT SetInitialDocFileName( | CATIxPDMItem_var& | iPDMItem, |
const CATUnicodeString& | iInitialFileName) |
public static HRESULT SynchronizeAllExternalLinks( | CATIxPDMItem_var& | iPDMItem) |
Notice that this API is equivalent to Synchronize button in Edit/Links panel.
Save is necessary after a synchronization.
public static HRESULT UnLoadItemFromSession( | const CATIxPDMItem_var& | iItemToUnLoad) |
This unload method can be used only is specific cases
In short, this method can be used only to clean a session, not for selective unloading in a Product Structure.
enum ItemRefresh { All, ReadWrite, UnresolvedLinks }Item information to refresh in session.
Copyright © 2003, Dassault Systèmes. All rights reserved.