pycatia.dnb_igp_setup_interfaces.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_setup_interfaces.tag_group.TagGroup(com_object)

Note

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

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

TagGroup

Interface representing a TagGroup.

Role: This interface is used to work with TagGroup which consists of a list of

Tags.

The following code snippet can be used to obtain a TagGroup from a selected

Product

Set ParentObject = CATIA.ActiveDocument.Selection.FindObject(“CATIAProduct”)

Set objTagGroup = ParentObject.GetTechnologicalObject(“TagGroup”)

create_tag(io_tag: Tag) → None

Note

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

o Sub CreateTag(Tag ioTag)

Creates a Tag

Parameters:

oTag

Newly created Tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

Dim objTagGroup As TagGroup

…

Dim objTag As Tag

objTagGroup.CreateTag objTag

Parameters:

io_tag (Tag) –

Return type:

None

delete_tag(i_tag: Tag) → None

Note

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

o Sub DeleteTag(Tag iTag)

Deletes a Tag

Parameters:

ioTag

Tag to be deleted

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

Dim objTagGroup As TagGroup

…

Dim objTag As Tag

objTagGroup.DeleteTag objTag

Parameters:

i_tag (Tag) –

Return type:

None

get_owner(io_parent_product: str) → None

Note

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

o Sub GetOwner(CATBSTR ioParentProduct)

Retrieves the name of the owner of this TagGroup.

Parameters:

ioParentProduct

Name of the owner of this TagGroup.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

Dim objTagGroup As TagGroup

…

Dim ownerName As String

objTagGroup.GetOwner ownerName

Parameters:

io_parent_product (str) –

Return type:

None

get_tag(index: int) → Tag

Note

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

o Func GetTag(short index) As Tag

Returns a Tag by Index.

Parameters:

index

Index of the required Tag.

oTag

Returned Tag.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

Dim objTagGroup As TagGroup

…

For i = 1 To objTagGroup.Count

Set objTag = objTagGroup.GetTag(i)

…

Next

Parameters:

index (int) –

Return type:

Tag

get_tag_list(io_tag_list: tuple) → None

Note

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

o Sub GetTagList(CATSafeArrayVariant ioTagList)

Gets the List of names of Tags

Parameters:

ioTagList

Underlying List of Tag names.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

Dim objTagGroup As TagGroup

…

Dim List(100)

objTagGroup.GetTagList List

Parameters:

io_tag_list (tuple) –

Return type:

None