pycatia.dnb_fastener_interfaces.fastener_group

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.dnb_fastener_interfaces.fastener_group.FastenerGroup(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
FastenerGroup
property colour: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Color(long iColor) (Write Only)

Sets the color of the fasteners.

Example:
This example sets the Color type of all the fasteners to
red

redCol =16711680 ‘Encoded RGB color within long integer (R=255 G=0
B=0)
MyFastenerGroup.Color = redCol
Return type:

int

get_count(id_name: str) → int

Note

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

Returns the number of entities in the fastener group of the
Type.

Parameters:

oNumOfEntities
The number of Entities

Example:
This example gets number of welds in the fastener
Group

Dim NumberOfWelds
NumberOfWelds = MyFastenerGroup.GetCount(“DELMIASpotWeld”)


This example gets number of FastenerGroups in the fastener
Group

Dim NumberOfGroups
NumberOfGroups = MyFastenerGroup.GetCount(“DELMIAFastenerGroup”)
Parameters:

id_name (str) –

Return type:

int

get_items(id_name: str, o_list_of_entities: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetItems(CATBSTR IDName,
CATSafeArrayVariant oListOfEntities)

Returns the entities in the fastener group of the type which is input.
which are direct children only

Example:
This example gets welds in the fastener Group

Dim NumberOfWelds
NumberOfWelds = MyFastenerGroup.GetItems(“DELMIASpotWeld”)


This example gets the FastenerGroups in the fastener Group

Dim NumberOfGroups
NumberOfGroups = MyFastenerGroup.GetItems(“DELMIAFastenerGroup”)
Parameters:

  • id_name (str) –

  • o_list_of_entities (tuple) –

Return type:

None

get_joined_part_names(o_list_of_parts: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetJoinedPartNames(CATSafeArrayVariant oListOfParts)

Returns the list of part names joined by fastener.

Parameters:

oListOfParts
The list of parts

Example:
This example gets list of parts joined by fastener

Dim NumberOfParts
Dim JoiningParts()
NumberOfParts = MyFastenerGroup.NumberOfJoiningParts
ReDim JoiningParts(NumParts-1)
MyFastenerGroup.GetJoinedPartNames(JoiningParts)
Parameters:

o_list_of_parts (tuple) –

Return type:

None

get_part(index: int) → Product

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPart(short index) As Product

Returns the product at the specified index from the list of parts joined by
fastener group.

Parameters:

index
Index should be greater than equal to 1.

Example:
This example gets the part at index 1

Dim MyProduct As Product
Set MyProduct = MyFastenerGroup.GetPart(1)
Parameters:

index (int) –

Return type:

Product

hide() → None

Note

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

Hides all the entities in the fastener group.

Example:
This example hides all the welds in the fastener Group

MyFastenerGroup.Hide
Return type:

None

number_of_joining_parts() → int

Note

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

Returns the number of parts joined by the fastener group.

Parameters:

oNumOfParts
The number of parts

Example:
This example gets number of parts joined by fastener

Dim NumberOfParts
NumberOfParts = MyFastenerGroup.NumberOfJoiningParts
Return type:

int

show() → None

Note

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

Shows all the entities in the fastener group.

Example:
This example shows all the welds in the fastener Group

MyFastenerGroup.Show
Return type:

None

property style: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Style(CATBSTR iStyle) (Write Only)

Sets the CGR Style representation for the Spot Welds in the 3D
Viewer.

Parameters:

iStyleType
of the CGR Style to be used for representation.
The valid set of Styles are :-

As specified in XML in tools-options page

Example:
This example sets the CGR Style type of all the fasteners to
Sphere provided it is available in XML file

MyFastenerGroup.Style = “Sphere”
Return type:

str

property symbol: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Symbol(CATBSTR iColor) (Write Only)

Sets the symbol for representation for the Spot Welds in the 3D
Viewer.

Parameters:

iSymbolType
of the symbol to be used for representation.
The valid set of symbols are :-

CROSS
PLUS
CONCENTRIC
COINCIDENT
FULLCIRCLE
FULLSQUARE
STAR
DOT
SMALLDOT

Example:
This example sets the Symbol type of all the fasteners to
FULLSquare

MyFastenerGroup.Symbol = “FULLSQUARE”
Return type:

str