pycatia.cat_sch_platform_interfaces.sch_comp_flow

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_comp_flow.SchCompFlow(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
SchCompFlow

Manage the internal flow of a schematic component.
add_internal_flow(i_l_flow_cntrs: SchListOfObjects) → SchInternalFlow

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddInternalFlow(SchListOfObjects iLFlowCntrs) As
SchInternalFlow

Add an internal flow to a component.

Parameters:

iLFlowCntrs
List of connectors (2) to be connected by the flow. (members should
be CATISchAppConnector interface pointer)
oInternalFlowAdded
Internal flow object added/created (CATISchInternalFlow interface
pointer).

Example:

Dim objThisIntf As SchCompFlow
Dim objArg1 As SchListOfObjects
Dim objArg2 As SchInternalFlow
…
Set objArg2 = objThisIntf.AddInternalFlow(objArg1)
Parameters:

i_l_flow_cntrs (SchListOfObjects) –

Return type:

SchInternalFlow

add_internal_flow_specify_grr(i_l_flow_cntrs: SchListOfObjects, i_l_owner_grr: SchListOfObjects) → SchInternalFlow

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddInternalFlowSpecifyGRR(SchListOfObjects
iLFlowCntrs,
SchListOfObjects iLOwnerGRR) As SchInternalFlow

Add an internal flow to a component. Specifying which graphical images the
connector graphics are on.

Parameters:

iLFlowCntrs
List of connectors (2) to be connected by the flow. (members should
be CATISchAppConnector interface pointer)
iLOwnerImages
List of CATISchGRRComp interface pointers
oInternalFlowAdded
Internal flow object added/created (CATISchInternalFlow interface
pointer).

Example:

Dim objThisIntf As SchCompFlow
Dim objArg1 As SchListOfObjects
Dim objArg2 As SchListOfObjects
Dim objArg3 As SchInternalFlow
…
Set objArg3 = objThisIntf.AddInternalFlowSpecifyGRR(objArg1,objArg2)
Parameters:
Return type:

SchInternalFlow

list_internal_flows() → SchListOfObjects

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ListInternalFlows() As SchListOfObjects

List all internal flow objects of a component.

Parameters:

oLInternalFlow
A list of internal flow objects (members are CATISchInternalFlow
interface pointers).

Example:

Dim objThisIntf As SchCompFlow
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListInternalFlows
Return type:

SchListOfObjects

remove_internal_flow(i_internal_flow_to_remove: SchInternalFlow) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RemoveInternalFlow(SchInternalFlow
iInternalFlowToRemove)

Remove an internal flow from a component.

Parameters:

iInternalFlowToRemove
Internal flow object to be removed.

Example:

Dim objThisIntf As SchCompFlow
Dim objArg1 As SchInternalFlow
…
objThisIntf.RemoveInternalFlowobjArg1
Parameters:

i_internal_flow_to_remove (SchInternalFlow) –

Return type:

None