pycatia.cat_sch_platform_interfaces.sch_app_cntr_doc_link¶
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_sch_platform_interfaces.sch_app_cntr_doc_link.SchAppCntrDocLink(com_object)¶
Note
CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectSchAppCntrDocLinkManage a schematic connector.- app_get_link(o_l_cntrs: SchListOfObjects, o_l_document_names: SchListOfBSTRs, o_publication_name: str) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppGetLink(SchListOfObjects oLCntrs,SchListOfBSTRs oLDocumentNames,CATBSTR oPublicationName)Deprecated:V5R18 Use SchAppCntrDocLink.AppGetLinkedDocs instead. Get a list oflinked connector(s) and its document names or publication name.Parameters:oLCntrsA list of connectors that are linked to this connector.oLDocumentNamesA list of document names containing the linked connector.oPublicationNameThe publication name of the connector(s) linked to this connector.Example:Dim objThisIntf As SchAppCntrDocLinkDim objArg1 As SchListOfObjectsDim objArg2 As SchListOfBSTRsDim strVar3 As String…objThisIntf.AppGetLinkobjArg1,objArg2,strVar3
- Parameters:
o_l_cntrs (SchListOfObjects) –
o_l_document_names (SchListOfBSTRs) –
o_publication_name (str) –
- Return type:
None
- app_get_linked_docs(o_publication_name: str, o_l_document_name: SchListOfBSTRs, o_l_document_uuid: SchListOfBSTRs, o_l_open_status: SchListOfLongs, o_l_cntr: SchListOfObjects) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppGetLinkedDocs(CATBSTR oPublicationName,SchListOfBSTRs oLDocumentName,SchListOfBSTRs oLDocumentUuid,SchListOfLongs oLOpenStatus,SchListOfObjects oLCntr)Get a list of linked connectors, their documents’ names, uuids, and ‘openin session’ statuses, and a publication name of theconnectors.Parameters:oPublicationNameThe publication name of the connector(s) linked to this connector.oLDocumentNameA list of document names of the documents containing the linkedconnector(s).oLDocumentUuidA list of document UUIDs of the documents containing the linkedconnector(s).oLOpenStatusA list of integer flags specifying whether a linked document isopen in the session or not (1 - yes; 0 - no).oLCntrA list of connectors that are linked to this connector.Example:Dim objThisIntf As SchAppCntrDocLinkDim strVar1 As StringDim objArg2 As SchListOfBSTRsDim objArg3 As SchListOfBSTRsDim objArg4 As SchListOfLongsDim objArg5 As SchListOfObjects…objThisIntf.AppGetLinkedDocsstrVar1,objArg2,objArg3,objArg4,objArg5
- Parameters:
o_publication_name (str) –
o_l_document_name (SchListOfBSTRs) –
o_l_document_uuid (SchListOfBSTRs) –
o_l_open_status (SchListOfLongs) –
o_l_cntr (SchListOfObjects) –
- Return type:
None
- app_is_linkable(i_sch_connector: SchAppConnector, o_b_yes: bool) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppIsLinkable(SchAppConnector iSchConnector,boolean oBYes)Query whether this connector and input connector can belinked.Parameters:iSchConnectorThe connector to link to.oBYesIf TRUE, connectors can be linked.Example:Dim objThisIntf As SchAppCntrDocLinkDim objArg1 As SchAppConnectorDim bVar2 As boolean…objThisIntf.AppIsLinkableobjArg1,bVar2
- Parameters:
i_sch_connector (SchAppConnector) –
o_b_yes (bool) –
- Return type:
None
- app_link(i_sch_connector: SchAppConnector) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppLink(SchAppConnector iSchConnector)Create an external link to another connector.Parameters:iSchConnectorThe connector to link to.Example:Dim objThisIntf As SchAppCntrDocLinkDim objArg1 As SchAppConnector…objThisIntf.AppLinkobjArg1
- Parameters:
i_sch_connector (SchAppConnector) –
- Return type:
None
- app_link_init(i_publication_name: str) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppLinkInit(CATBSTR iPublicationName)Publish this connector to make it available for linking.Parameters:iPublicationNameThe publication name of connector.Example:Dim objThisIntf As SchAppCntrDocLinkDim strVar1 As String…objThisIntf.AppLinkInitstrVar1
- Parameters:
i_publication_name (str) –
- Return type:
None
- app_open_linked_doc(i_document_name: str, i_document_uuid: str, o_document: Document) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppOpenLinkedDoc(CATBSTR iDocumentName,CATBSTR iDocumentUuid,Document oDocument)Open a linked document.Parameters:iDocumentNameName of the document (from oLDocumentName list inAppGetLinkedDocs).iDocumentUuidUuid of the document (from oLDocumentUuid list inAppGetLinkedDocs).oDocumentPointer to the document.Example:Dim objThisIntf As SchAppCntrDocLinkDim strVar1 As StringDim strVar2 As StringDim objArg3 As Document…objThisIntf.AppOpenLinkedDocstrVar1,strVar2,objArg3
- Parameters:
i_document_name (str) –
i_document_uuid (str) –
o_document (Document) –
- Return type:
None
- app_un_link(i_unpublish: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Sub AppUnLink(long iUnpublish)Remove external link to another connector.Parameters:iUnpublishiUnpublish = 0, do not delete publication connector (default)iUnpublish > 0, delete publication connectorExample:Dim objThisIntf As SchAppCntrDocLinkDim intVar1 As Integer…objThisIntf.AppUnLinkintVar1
- Parameters:
i_unpublish (int) –
- Return type:
None