pycatia.structure_interfaces.str_member

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.structure_interfaces.str_member.StrMember(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
ProductStructureInterfaces.Product
StructureInterfaces.StrObject
StrMember

Represents a member object.
The member object aggregates a section coming from a catalog, a support and two
extremities. The member object inherits all methods from the structure object
and the product object.
property angle: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Angle() As double

Returns or set the orientation of the section on the support
object.

Example:



angle = Member_1.Angle
Return type:

float

property angle_parameter: Parameter

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AngleParameter() As Parameter (Read Only)

Returns the parameter used to define the orientation of the section on the
support object.

Example:



Dim angle As Parameter
Set angle = Member_1.AngleParameter
Return type:

Parameter

create_cutback(i_member: StrMember, i_cutback: int, i_offset: float) → StrCutback

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateCutback(StrMember iMember,
CatStrCutbackType iCutback,
double iOffset) As StrCutback

Creates a cutback object between two member objects.

Parameters:

iMember
The relimiting member
iCutback
The type of the cutback.
iOffset
The offset used in the cutback.

Example:

The following example create a cutback



Dim cutback As StrCutback
Set cutback = Member_1.CreateCutback(Member_2, catStrWeldedType, 0.05)
Parameters:

  • i_member (StrMember) –

  • i_cutback (int) – enum cat_str_cutback_type

  • i_offset (float) –

Return type:

StrCutback

property current_anchor_point_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CurrentAnchorPointName() As CATBSTR

Returns or sets the current anchor point used to locate the section on the
support object.

Example:



name = Member_1.CurrentAnchorPointName
Return type:

str

property end_extremity: StrMemberExtremity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property EndExtremity() As StrMemberExtremity (Read Only)

Returns the member’s end extremity object.

Example:



Dim extremity As StrMemberExtremity
Set extremity = Member_1.EndExtremity
Return type:

StrMemberExtremity

flip() → None

Note

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

Flips the section. Useful for asymetric section as the angle section, or
the channel section.

Example:



Member_1.Rotate(1,25)
Return type:

None

property input_support: Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property InputSupport() As Reference (Read Only)

Retrieves the input support. The input support is the given support at the
creation of the member.
Return type:

Reference

rotate(i_angle: float) → None

Note

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

Rotates the section on its support object. The given angle is applied using
the current orientation of the section.

Example:



Dim extremity As StrMemberExtremity
Set extremity = Member_1.StartExtremity
Parameters:

i_angle (float) –

Return type:

None

property section: StrSection

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Section() As StrSection (Read Only)

Returns or sets the section object.

Example:



Dim section As StrSection
Set section = Member_1.Section
Return type:

StrSection

property start_extremity: StrMemberExtremity

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property StartExtremity() As StrMemberExtremity (Read Only)

Returns the member’s start extremity object.

Example:



Dim extremity As StrMemberExtremity
Set extremity = Member_1.StartExtremity
Return type:

StrMemberExtremity

property support: Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Support() As Reference (Read Only)

Retrieves the result support object. For example, if your member object is
created using two points, the result support object will be the line joining
these two points.
Return type:

Reference

property surface_reference: Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SurfaceReference() As Reference

Retrieves or sets the surface reference object for the member. The section
will be oriented using this surface reference object if one is set.
Nevertheless, the surface reference object can be null.

Example:
This example sets the reference object to null.

myMember.SurfaceReference = Nothing
Return type:

Reference