pycatia.cat_plant_ship_interfaces.psp_logical_line

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_logical_line.PSPLogicalLine(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
CATPlantShipInterfaces.PspGroup
PspLogicalLine

Represents the logical line.
Role: To query the logical line object’s from/to members.
get_from_to(o_list_from_major: PSPListOfObjects, o_list_from_minor: PSPListOfObjects, o_list_to_major: PSPListOfObjects, o_list_to_minor: PSPListOfObjects) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetFromTo(PspListOfObjects oListFromMajor,
PspListOfObjects oListFromMinor,
PspListOfObjects oListToMajor,
PspListOfObjects oListToMinor)

Retrieves the lists of major and minor from/to members from this
line.
The members retrieved are all PspGroupable objects.

Parameters:

oListFromMajor
The list of major from members
oListFromMinor
The list of minor from members
oListToMajor
The list of major to members
oListToMinor
The list of minor to members

Example:

Dim objThisIntf As PspLogicalLine
Dim objArg1 As PspListOfObjects
Dim objArg2 As PspListOfObjects
Dim objArg3 As PspListOfObjects
Dim objArg4 As PspListOfObjects
…
objThisIntf.GetFromTo objArg1, objArg2, objArg3,
objArg4
Parameters:
Return type:

None

get_from_to_info_array_max_size() → int

Note

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

Returns the maximum possible size of the from-to
information.

Returns:
The maximum possible size of the array to hold the information returned
by GetFromToInformation

Example:

Dim objThisIntf As PspLogicalLine
Dim intValueMaxSize As Integer
…
intValueMaxSize = objThisIntf.GetFromToInfoArrayMaxSize
Return type:

int

get_from_to_information(o_from_to_label: tuple, o_ft_major: tuple, o_ft_minor: tuple, o_size_of_output: int) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetFromToInformation(CATSafeArrayVariant oFromToLabel,
CATSafeArrayVariant oFTMajor,
CATSafeArrayVariant oFTMinor,
long oSizeOfOutput)

Retrieves the from/to information of a logical line.

Parameters:

oFromToLabel
The array of labels (“From” or “To”)
oFTMajor
The array of from/to major IDs
oFTMinor
The array of from/to minor IDs
The
size of the output arrays

Example:

Dim objThisIntf As PspLogicalLine
Dim strFromToLabel(20) As String
Dim strFromToMajor(20) As String
Dim strFromToMinor(20) As String
Dim intValueMaxSize As Integer
intValueMaxSize = objThisIntf.GetFromToInfoArrayMaxSize
…
‘—- make sure the array size if big enough
If (intValueMaxSize ≤ 20) Then
objThisIntf.GetFromToInformation _
strFromToLabel, strFromToMajor, strFromToMinor,
intValueMaxSize
End If

The following table can then be filled with the output
arrays.

From/To | F/T Major | F/T Minor
strFromToLabel(i) | strFromToMajor(i) |
strFromToMinor(i)
Parameters:

  • o_from_to_label (tuple) –

  • o_ft_major (tuple) –

  • o_ft_minor (tuple) –

  • o_size_of_output (int) –

Return type:

String