pycatia.dnb_igp_arc_commands.arc_tag

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.ARCTag(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

ARCTag

Interface representing a Tag.

Role: This interface is used to work with ARCTag.

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”)

get_arc_tag_group(o_arc_tag_group: cat_variant) → None

Note

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

o Sub GetARCTagGroup(CATVariant oARCTagGroup)

Function to get the parent ARC TagGroup of the ARC tag.

Parameters:

oARCTagGroup

the parent ARCTagGroup.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Parameters:

o_arc_tag_group (cat_variant) –

Return type:

None

get_aux_axes_values(io_aux_axes_values_list: tuple) → None

Note

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

o Sub GetAuxAxesValues(CATSafeArrayVariant

ioAuxAxesValuesList)

Function to get the aux axes values associated with the ARC

tag.

Parameters:

ioAuxAxesValuesList

the aux axes values( array of double values ) associated with the

ARC tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

io_aux_axes_values_list (tuple) –

Return type:

None

get_base_surface_normal(o_base_vec: tuple) → None

Note

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

o Sub GetBaseSurfaceNormal(CATSafeArrayVariant oBaseVec)

Function to get the Base Surface Normal associated with the ARC

tag.

Parameters:

oWallVec

Base surface normal vector( array of 3 real values ).

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

o_base_vec (tuple) –

Return type:

None

get_index(o_index: int) → None

Note

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

o Sub GetIndex(short oIndex)

Function to get the index of the ARC tag in it’s parent ARC

TagGroup.

Parameters:

oIndex

the index of the ARC tag in it’s parent ARC TagGroup.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

o_index (int) –

Return type:

None

get_tag(o_tag: cat_variant) → None

Note

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

o Sub GetTag(CATVariant oTag)

Function to get the underlying basic Tag.

Parameters:

oTag

the underlying basic Tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Parameters:

o_tag (cat_variant) –

Return type:

None

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

Note

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

o Sub GetTagParam(CATBSTR iParamName,

double oVal)

Function to get the value of a given ARC tag parameter.

Parameters:

iParamName

the name of the ARC tag parameter. Values of following ARC tag

parameters can be gotten: “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_param_name (str) –

• o_val (float) –

Return type:

None

get_wall_surface_normal(o_wall_vec: tuple) → None

Note

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

o Sub GetWallSurfaceNormal(CATSafeArrayVariant oWallVec)

Function to get the Wall Surface Normal associated with the ARC

tag.

Parameters:

oWallVec

Wall surface normal vector( array of 3 real values ).

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

o_wall_vec (tuple) –

Return type:

None

get_weld_geometry(b_status: int) → None

Note

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

o Sub GetWeldGeometry(short bStatus)

Function to find whether wall/base normals are available for the ARC

tag.

Parameters:

bStatus

Boolean flag indicating whether wall/base normals are set for the

ARC tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

b_status (int) –

Return type:

None

rotate(i_angle: float, i_dir_vector: tuple) → None

Note

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

o Sub Rotate(double iAngle,

CATSafeArrayVariant iDirVector)

Function to Rotate the ARC tag about a given direction vector as the axis

of rotation.

Parameters:

iAngle

the angle by which the ARC tag should be rotated about the given

direction vector as the axis of rotation.

iDirVector

the given direction vector( array of 3 real values; axis of

rotation ) about which the ARC tag has to be rotated.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

• i_angle (float) –

• i_dir_vector (tuple) –

Return type:

None

rotate_x(i_angle: float) → None

Note

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

o Sub RotateX(double iAngle)

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

Parameters:

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_angle (float) –

Return type:

None

rotate_y(i_angle: float) → None

Note

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

o Sub RotateY(double iAngle)

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

Parameters:

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_angle (float) –

Return type:

None

rotate_z(i_angle: float) → None

Note

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

o Sub RotateZ(double iAngle)

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

Parameters:

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_angle (float) –

Return type:

None

set_base_surface_normal(i_base_vec: tuple) → None

Note

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

o Sub SetBaseSurfaceNormal(CATSafeArrayVariant iBaseVec)

Function to set the Base Surface Normal associated with the ARC

tag.

Parameters:

iBaseVec

Base surface normal vector( array of 3 real values ).

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

i_base_vec (tuple) –

Return type:

None

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

Note

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

o Sub SetTagParam(CATBSTR iParamName,

double iVal)

Function to set the value of a given ARC tag parameter.

Parameters:

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_param_name (str) –

• i_val (float) –

Return type:

None

set_wall_surface_normal(i_wall_vec: tuple) → None

Note

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

o Sub SetWallSurfaceNormal(CATSafeArrayVariant iWallVec)

Function to set the Wall Surface Normal associated with the ARC

tag.

Parameters:

iWallVec

Wall surface normal vector( array of 3 real values ).

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

i_wall_vec (tuple) –

Return type:

None

set_weld_geometry(b_status: int) → None

Note

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

o Sub SetWeldGeometry(short bStatus)

Function to set the flag for the availability of wall/base normals for the

ARC tag.

Parameters:

bStatus

Boolean flag indicating whether wall/base normals should be

available for the ARC tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

b_status (int) –

Return type:

None

translate(i_distance: float, i_dir_vector: tuple) → None

Note

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

o Sub Translate(double iDistance,

CATSafeArrayVariant iDirVector)

Function to translate the ARC tag along a given direction

vector.

Parameters:

iDistance

the distance by which the ARC tag should be translated along the

given direction vector.

iDirVector

the given direction vector( array of 3 real values ) along which

the ARC tag has to be translated.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise.

Parameters:

• i_distance (float) –

• i_dir_vector (tuple) –

Return type:

None

translate_along_seam(i_distance: float) → None

Note

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

o Sub TranslateAlongSeam(double iDistance)

Function to translate the ARC tag along the seam.

Parameters:

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_distance (float) –

Return type:

None