pycatia.cat_plant_ship_interfaces.psp_workbench

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.cat_plant_ship_interfaces.psp_workbench.PSPWorkbench(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
PspWorkbench

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.
export_properties(i_document_to_export_from: Document, i_xml_output_file_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ExportProperties(Document iDocumentToExportFrom,
CATBSTR 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
Parameters:

  • i_document_to_export_from (Document) –

  • i_xml_output_file_name (str) –

Return type:

None

get_application(i_application_id: int) → PSPApplication

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetApplication(CatPspIDLApplicationID iApplicationID) As
PspApplication

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)
Parameters:

i_application_id (int) – enum cat_psp_idl_application_id

Return type:

PSPApplication

get_interface(i_interface_name: str, i_object: AnyObject) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetInterface(CATBSTR iInterfaceName,
AnyObject iObject) As AnyObject

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)
Parameters:

  • i_interface_name (str) –

  • i_object (AnyObject) –

Return type:

AnyObject