pycatia.dnb_igp_setup_interfaces.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_setup_interfaces.tag.Tag(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

Tag

Interface representing a Tag.

Role: This interface is used to work with Tag.

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_name(o_tag_name: str) → None

Note

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

o Sub GetName(CATBSTR oTagName)

Retreives name of the Tag.

Parameters:

oTagName

Name of the Tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

Dim Name as String

objTag.GetName Name

Parameters:

o_tag_name (str) –

Return type:

None

get_type(o_frame_name: str) → None

Note

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

o Sub GetType(CATBSTR oFrameName)

Get Frame Type of the Tag by Name.

Parameters:

oFrameName

Name of the Required Frame.

Legal values : Returned tag frame by Name is either :

Manufacturing,

Design,

Tool,

Base,

Custom

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

Dim FrameType as String

objTag.GetType FrameType

Parameters:

o_frame_name (str) –

Return type:

None

get_xyz(io_xyz: tuple) → None

Note

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

o Sub GetXYZ(CATSafeArrayVariant ioXYZ)

Gets the Position(X, Y, Z) of the Tag.

Parameters:

ioXYZ

The underlying Tag position.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

Dim List(3)

objTag.GetXYZ List

Parameters:

io_xyz (tuple) –

Return type:

None

get_ypr(io_ypr: tuple) → None

Note

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

o Sub GetYPR(CATSafeArrayVariant ioYPR)

Gets the Orientation (Y, P, R) of the Tag.

Parameters:

ioYPR

The underlying Tag orientation.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

Dim List(3)

objTag.GetYPR List

Parameters:

io_ypr (tuple) –

Return type:

None

set_name(i_tag_name: str) → None

Note

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

o Sub SetName(CATBSTR iTagName)

Sets name of the Tag.

Parameters:

iTagName

Name of the Tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

objTag.SetName(“My_Tag”)

Parameters:

i_tag_name (str) –

Return type:

None

set_type(i_frame_name: str) → None

Note

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

o Sub SetType(CATBSTR iFrameName)

Sets Frame Type of the Tag by Name.

Parameters:

iFrameName

Name of the Required Frame.

Legal values : Tag frame can be set by name to either :

Manufacturing,

Design,

Tool,

Base,

Custom

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

objTag.SetType(“Design”)

Parameters:

i_frame_name (str) –

Return type:

None

set_xyz(i_x: float, i_y: float, i_z: float) → None

Note

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

o Sub SetXYZ(double iX,

double iY,

double iZ)

Sets the Position(X, Y, Z) of the Tag.

Parameters:

iX

The X value of the position

iY

The Y value of the position

iZ

The Z value of the position

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

objTag.SetXYZ 2800.0, 1800.0, 800.0

Parameters:

• i_x (float) –

• i_y (float) –

• i_z (float) –

Return type:

None

set_ypr(i_y: float, i_p: float, i_r: float) → None

Note

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

o Sub SetYPR(double iY,

double iP,

double iR)

Sets the Orientation (Y, P, R) of the Tag.

Parameters:

iY

The yaw value of the oreintation

iP

The pitch value of the orientation

iR

The roll value of the orientation

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

.

Example:

Dim objTag As Tag

…

objTag.SetYPR 1.4, 0.5, 3.14

Parameters:

• i_y (float) –

• i_p (float) –

• i_r (float) –

Return type:

None