pycatia.cat_sch_platform_interfaces.sch_internal_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_internal_flow.SchInternalFlow(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
SchInternalFlow

Represents the internal flow object in a schematic component.
get_insertion_type() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetInsertionType(CatSchIDLInternalFlowType
oEInternalFlowType)

Get insertion flow type.

Parameters:

oEInternalFlowType
Internal flow type.

Example:

Dim objThisIntf As SchInternalFlow

…
objThisIntf.GetInsertionTypeCatSchIDLInternalFlowType_Enum
Returns:

enum cat_sch_idl_internal_flow_type

Return type:

None

get_status() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetStatus(CatSchIDLInternalFlowStatus
oEInternalFlowStatus)

Get insertion flow status.

Parameters:

oEInternalFlowStatus
Internal flow status.

Example:

Dim objThisIntf As SchInternalFlow

…
objThisIntf.GetStatusCatSchIDLInternalFlowStatus_Enum
Returns:

enum cat_sch_idl_internal_flow_status

Return type:

int

list_sch_connectors() → SchListOfObjects

Note

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

List all schematic connectors associated with an internal
flow.

Parameters:

oLSchCntrs
A list of schematic connector objects (members are
CATISchCntrLocation interface pointers).

Example:

Dim objThisIntf As SchInternalFlow
Dim objArg1 As SchListOfObjects
…
Set objArg1 = objThisIntf.ListSchConnectors
Return type:

SchListOfObjects

set_status(i_e_internal_flow_status: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetStatus(CatSchIDLInternalFlowStatus
iEInternalFlowStatus)

Set insertion flow status.

Parameters:

iEInternalFlowStatus
Internal flow status.

Example:

Dim objThisIntf As SchInternalFlow

…
objThisIntf.SetStatusCatSchIDLInternalFlowStatus_Enum
Parameters:

i_e_internal_flow_status (int) – enum cat_sch_idl_internal_flow_status

Return type:

None