pycatia.cat_plant_ship_interfaces.psp_part_connector

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_part_connector.PSPPartConnector(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

PspPartConnector

Represent the Part Connector to manage the technological data on

connectors.

Role: To access the technological data on connectors.

property align_type: int

Note

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

o Property AlignType() As CatPspIDLPartConnectorType (Read

Only)

Returns the alignment type for this connector.

See also:

CatPspIDLPartConnectorType

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As CatPspIDLPartConnectorType

…

objArg1 = objThisIntf.AlignType

Returns:

enum cat_psp_idl_part_connector_type

Return type:

int

property attribute_names: PSPListOfBSTRs

Note

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

o Property AttributeNames() As PspListOfBSTRs

Returns or sets a list of attribute names associated with this

connector.

Example:

Dim objThisIntf As PspPartConnector

Dim ojArg1 As PspListOfBSTRs

…

Set ojArg1 = objThisIntf.AttributeNames

Return type:

PSPListOfBSTRs

property clock_type: int

Note

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

o Property ClockType() As CatPspIDLPartConnectorType (Read

Only)

Returns the clocking type (how symmetric this end is) for this

connector.

See also:

CatPspIDLPartConnectorType

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As CatPspIDLPartConnectorType

…

objArg1 = objThisIntf.ClockType

Returns:

enum cat_psp_idl_part_connector_type

Return type:

int

property face_type: int

Note

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

o Property FaceType() As CatPspIDLPartConnectorType (Read

Only)

Returns the face type (normal or “transparent” support) for this

connector.

Parameters:

oFaceType

The face type.

See also:

CatPspIDLPartConnectorType

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As CatPspIDLPartConnectorType

…

Set objArg1 = objThisIntf.FaceType

Returns:

enum cat_psp_idl_part_connector_type

Return type:

int

get_alignment_connector() → Reference

Note

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

o Func GetAlignmentConnector() As Reference

Returns the Alignmnet connector.

Parameters:

oCntr

Alignment connector

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

…

Set objArg1 = objThisIntf.GetAlignmentConnector

Return type:

Reference

get_alignment_direction(i_rel_axis: Product) → PSPListOfDoubles

Note

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

o Func GetAlignmentDirection(Product iRelAxis) As

PspListOfDoubles

Retrieves the alignment direction outward normal to the face place

position.

Parameters:

iRelAxis

the relative axis object (Nothing means relative to parent)

oAlignmentDirection

Three double values stand for X,Y,Z components of the alignment

vector

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Product

Dim objArg2 As PspListOfDoubles

…

Set objArg2 = objThisIntf.GetAlignmentVector (objArg1)

Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

get_connector_math_plane(i_rel_axis: Product) → PSPListOfDoubles

Note

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

o Func GetConnectorMathPlane(Product iRelAxis) As

PspListOfDoubles

Returns the 9 doubles values for plane contains the connector position

(plane origin), alignment direction (plane z-axis), and the up direction (plane

y-axis). Nine double values stand for plane origin, and the two normalized

vectors

Parameters:

iRelAxis

The relative axis object (Nothing means relative to parent).

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Product

Dim objArg2 As PspListOfDoubles

…

Set objArg2 = objThisIntf.GetConnectorMathPlane (objArg1)

Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

get_datum_connector() → Reference

Note

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

o Func GetDatumConnector() As Reference

Returns the Datum connector.

Parameters:

oCntr

Orientation connector

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

…

Set objArg1 = objThisIntf.GetDatumConnector

Return type:

Reference

get_face_connector() → Reference

Note

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

o Func GetFaceConnector() As Reference

Returns the face connector.

Parameters:

oCntr

Face connector

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

…

Set objArg1 = objThisIntf.GetFaceConnector

Return type:

Reference

get_orientation_connector() → Reference

Note

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

o Func GetOrientationConnector() As Reference

Get Orientation connector.

Parameters:

oCntr

Orientation connector

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

…

Set objArg1 = objThisIntf.GetOrientationConnector

Return type:

Reference

get_position(i_rel_axis: Product) → PSPListOfDoubles

Note

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

o Func GetPosition(Product iRelAxis) As PspListOfDoubles

Returns the Position of the connector.

Parameters:

iRelAxis

The relative axis object (NULL means relative to parent).

oPosition

X-Y-Z coordinates of the part connector Three double values stand

for x,y,z coordinates

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Product

Dim objArg2 As PspListOfDoubles

…

Set objArg2 = objThisIntf.GetPosition (objArg1 )

Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

get_up_direction(i_rel_axis: Product) → PSPListOfDoubles

Note

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

o Func GetUpDirection(Product iRelAxis) As PspListOfDoubles

Returns the UP direction of the connector.

Parameters:

iRelAxis

The relative axis object (Nothing means relative to parent).

oUpDirection

The connector face plane.

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Product

Dim objArg2 As PspListOfDoubles

…

Set objArg2 = objThisIntf.GetUpDirection (objArg1)

Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

set_alignment_connector(i_align_cntr: Reference, ie_align_type: int) → None

Note

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

o Sub SetAlignmentConnector(Reference iAlignCntr,

CatPspIDLPartConnectorType ieAlignType)

Sets the Face connector.

Parameters:

iAlignCntr

Alignment connector

ieAlignType

Alignment connector Type

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

Dim objArg2 As CatPspIDLPartConnectorType

…

objThisIntf.SetFaceConnector objArg1, objArg2

Parameters:

• i_align_cntr (Reference) –

• ie_align_type (int) – enum cat_psp_idl_part_connector_type

Return type:

None

set_datum_connector(i_datum_cntr: Reference) → None

Note

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

o Sub SetDatumConnector(Reference iDatumCntr)

Sets the Datum connector.

Parameters:

iDatumCntr

Datum connector.

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

…

objThisIntf.SetDatumConnector objArg1

Parameters:

i_datum_cntr (Reference) –

Return type:

None

set_face_connector(i_face_cntr: Reference, ie_face_type: int) → None

Note

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

o Sub SetFaceConnector(Reference iFaceCntr,

CatPspIDLPartConnectorType ieFaceType)

Sets Face connector.

Parameters:

iFaceCntr

Face connector

ieFaceType

Face connector Type

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

Dim objArg2 As CatPspIDLPartConnectorType

…

objThisIntf.SetFaceConnector objArg1, objArg2

Parameters:

• i_face_cntr (Reference) –

• ie_face_type (int) – enum cat_psp_idl_part_connector_type

Return type:

None

set_orientation_connector(i_orient_cntr: Reference, ie_orientation: int) → None

Note

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

o Sub SetOrientationConnector(Reference iOrientCntr,

CatPspIDLPartConnectorType ieOrientation)

Sets Face connector.

Parameters:

iOrientCntr

Alignment connector

ieOrientation

Orientation connector Type

Example:

Dim objThisIntf As PspPartConnector

Dim objArg1 As Reference

Dim objArg2 As CatPspIDLPartConnectorType

…

objThisIntf.SetOrientationConnector objArg1, objArg2

Parameters:

• i_orient_cntr (Reference) –

• ie_orientation (int) – enum cat_psp_idl_part_connector_type

Return type:

None