All Frameworks  Object Hierarchy  This Framework  Indexes   

PspWorkbench (Object)

Represents the PspWorkbench.
Role: To manage application and Psp interface handlers. From this object all the queries for lists of Distributive system (PSP) objects can be made. Furthermore, all the interface handles can be obtained through this interface.

Method Index

ExportProperties
This method extracts property values of the current document to an output XML file.
GetApplication
Returns the PspApplication associated with the input ApplicationID.
GetInterface
Returns specific interface handle on a given object.

Methods


o Sub ExportProperties( iDocumentToExportFrom,
iXMLOutputFileName)
This method extracts property values of the current document to an output XML file. The format is determined by CATIA PlantShip XML-DTD file.
Parameters:
iDocumentToExportFrom
Documennt to export from
iXMLOutputFileName
The file name to output the data to.
Example:
 Dim objPspWorkbench As PspWorkbench  
 Dim objCATIAV5CurDocument As Document
 Dim iXMLOutputFileName As String
 Set objCATIAV5CurDocument = CATIA.ActiveDocument  
 Set objProductRoot = objCATIAV5CurDocument.Product
 Set objPspWorkbench = objProductRoot.GetTechnologicalObject ("PspWorkbench")
 ..
 objThisIntf.ExportProperties objCATIAV5CurDocument, iXMLOutputFileName
 
o Func GetApplication( iApplicationID) As
Returns the PspApplication associated with the input ApplicationID.
Parameters:
CatPspIDLApplicationID
Application ID to get.
oApplication
PspApplication handle found.
Example:
 Dim objPspWorkbench As PspWorkbench
 Dim objArg1 As CatPspIDLApplicationID
 Dim objArg2 As PspApplication
 objArg1 = catPspIDLCATPiping
 Set objArg2 = objPspWorkbench.GetApplication (objArg1)
 
o Func GetInterface( iInterfaceName,
iObject) As
Returns specific interface handle on a given object.
Parameters:
iInterfaceName
interface name to search for ("CATIAxxxx")
iObject
The object to search for the required interface.
Returns:
Interface handle found
Example:
This example illustrates how to get a specific interface handle from a given object.
 Dim objPspWorkbench As PspWorkbench
 Dim objPspApplication As PspApplication
 Dim objPspAppFactory As PspAppFactory
 Dim objProductRoot As Product
 Set objProductRoot = CATIA.ActiveDocument.Product
 Set objPspWorkbench = objProductRoot.GetTechnologicalObject ("PspWorkbench")
 Set objPspPipApplication = objPspWorkbench.GetApplication(catPspIDLCATPiping)

 Set objPspPipAppFactory = objPspWorkbench.GetInterface ("CATIAPspAppFactory",objPspPipApplication)
 

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