pycatia.dnb_igp_arc_commands.arc_tag_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_igp_arc_commands.arc_tag_group.ARCTagGroup(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
ARCTagGroup

Interface representing a Tag.

Role: This interface is used to work with ARCTagGroup.
The following code snippet can be used to obtain a Tag from a selected
Product

Set ParentObject = CATIA.ActiveDocument.Selection.FindObject(“CATIAProduct”)
Set objTag = ParentObject.GetTechnologicalObject(“Tag”)
compute_distance_along_seam(i_first_tag_idx: int, i_second_tag_idx: int, o_distance: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ComputeDistanceAlongSeam(short iFirstTagIdx,
short iSecondTagIdx,
double oDistance)

Function to compute the distance along the seam between two ARC tags of the
ARCTagGroup.

Parameters:

iFirstTagIdx
the index of the first tag.
iSecondTagIdx
the index of the second tag.
oDistance
the computed distance along the seam.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_first_tag_idx (int) –

  • i_second_tag_idx (int) –

  • o_distance (float) –

Return type:

None

get_arc_tags_list(o_arc_tag_list: tuple) → None

Note

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

Function to get all the ARC tags grouped by the
ARCTagGroup.

Parameters:

oARCTagList
the ARC tags list.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

o_arc_tag_list (tuple) –

Return type:

None

get_num_arc_tags(o_size: int) → None

Note

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

Function to get the total number of ARC tags grouped by the
ARCTagGroup.

Parameters:

oSize
the total number of ARC tags grouped by the ARCTagGroup.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

o_size (int) –

Return type:

None

get_tag_group(o_tag_group: cat_variant) → None

Note

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

Function to get the underlying basic TagGroup.

Parameters:

oTagGroup
the underlying basic TagGroup.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

o_tag_group (cat_variant) –

Return type:

None

get_tag_param(i_idx: int, i_param_name: str, o_val: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetTagParam(short iIdx,
CATBSTR iParamName,
double oVal)

Function to get the value of a given ARC tag parameter. The concerned ARC
tag’s index should be given.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iParamName
the name of the ARC tag parameter. Following ARC tag parameters can
be set: “WireAngle”, “FlareAngle”, “RakeAngle”, “WireRollAngle”,
“BaseTangentOffset”, “WallTangentOffset”, “ShiftDistance”, “FlareLength”,
“StickOut”, “TCPStickOut”, “NearDistance”
oVal
the value of the ARC tag parameter.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_param_name (str) –

  • o_val (float) –

Return type:

None

rotate_tag(i_idx: int, i_angle: float, i_dir_vector: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RotateTag(short iIdx,
double iAngle,
CATSafeArrayVariant iDirVector)

Function to rotate the ARC tag with the given index about the given
direction vector.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iAngle
the angle by which the ARC tag should be rotated about the given
direction vector.
iDirVector
the direction vector( array of 3 real values ).

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_angle (float) –

  • i_dir_vector (tuple) –

Return type:

None

rotate_x_tag(i_idx: int, i_angle: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RotateXTag(short iIdx,
double iAngle)

Function to rotate the ARC tag with the given index about it’s
x-axis.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iAngle
the angle by which the ARC tag should be rotated about it’s x-axis.


Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_angle (float) –

Return type:

None

rotate_y_tag(i_idx: int, i_angle: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RotateYTag(short iIdx,
double iAngle)

Function to rotate the ARC tag with the given index about it’s
y-axis.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iAngle
the angle by which the ARC tag should be rotated about it’s y-axis.


Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_angle (float) –

Return type:

None

rotate_z_tag(i_idx: int, i_angle: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RotateZTag(short iIdx,
double iAngle)

Function to rotate the ARC tag with the given index about it’s
z-axis.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iAngle
the angle by which the ARC tag should be rotated about it’s z-axis.


Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_angle (float) –

Return type:

None

set_tag_param(i_idx: int, i_param_name: str, i_val: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetTagParam(short iIdx,
CATBSTR iParamName,
double iVal)

Function to set the value of a given ARC tag parameter. The concerned ARC
tag’s index should be given.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iParamName
the name of the ARC tag parameter. Following ARC tag parameters can
be set: “WireAngle”, “FlareAngle”, “RakeAngle”, “WireRollAngle”,
“BaseTangentOffset”, “WallTangentOffset”, “ShiftDistance”, “FlareLength”,
“StickOut”, “TCPStickOut”, “NearDistance”
iVal
the value of the ARC tag parameter.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_param_name (str) –

  • i_val (float) –

Return type:

None

translate_tag(i_idx: int, i_distance: float, i_dir_vector: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub TranslateTag(short iIdx,
double iDistance,
CATSafeArrayVariant iDirVector)

Function to translate the ARC tag with the given index along the given
direction vector.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iDistance
the distance by which the ARC tag should be translated along the
given direction vector.
iDirVector
the direction vector( array of 3 real values ).

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_distance (float) –

  • i_dir_vector (tuple) –

Return type:

None

translate_tag_along_seam(i_idx: int, i_distance: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub TranslateTagAlongSeam(short iIdx,
double iDistance)

Function to translate the ARC tag with the given index along the
seam.

Parameters:

iIdx
the index of the ARC tag in the ARCTagGroup.
iDistance
the distance by which the ARC tag should be translated along the
seam.

Returns:
an HRESULT value.
Legal values:

S_OK if the operation succeeds
E_FAIL otherwise.
Parameters:

  • i_idx (int) –

  • i_distance (float) –

Return type:

None