pycatia.dnb_igp_setup_interfaces.tag_group_factory

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_factory.TagGroupFactory(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

TagGroupFactory

Interface representing TagGroup factory.

Role: This allows the creation of a TagGroup

The following code snippet can be used to obtain a TagGroupFactory from a

selected Product

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

Set objTagGroupFact = ParentObject.GetTechnologicalObject(“TagGroupFactory”)

copy_tag_group(i_tag_group: TagGroup, io_tag_group: TagGroup) → TagGroup

Note

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

o Sub CopyTagGroup(TagGroup iTagGroup,

TagGroup ioTagGroup)

Copies a TagGroup to a new Product

Parameters:

iTagGroup

TagGroup to be copied.

ioTagGroup

The TagGroup to which iTagGroup gets copied

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

…

Dim objTagGroup(2) As TagGroup

Dim objTagGroupFactory as TagGroupFactory

…

objTagGroupFactory.CopyTagGroup objTagGroup(1),

objTagGroup(2)

Parameters:

• i_tag_group (TagGroup) –

• io_tag_group (TagGroup) –

Return type:

TagGroup

create_tag_group(i_tag_group_name: str, i_modify_reference: bool, i_product: Product, o_tag_group: TagGroup) → None

Note

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

o Sub CreateTagGroup(CATBSTR iTagGroupName,

boolean iModifyReference,

Product iProduct,

TagGroup oTagGroup)

Creates a TagGroup. Each TagGroup has a Name, an option to modify reference

or modify locally and, the reference product.

Parameters:

iTagGroupName

Name of the TagGroup to be created.

iModifyReference

Modify reference or modify locally.

iProduct

Reference product.

oTagGroup

Created TagGroup.

Returns:

An HRESULT.

Legal values:

S_OK

Action is successfully created and the interface pointer is

successfully returned

E_FAIL

Action was successfully created, but the interface query

failed

E_NOINTERFACE

Action was successfully created, but the it doesn’t implement the

requested interface

E_OUTOFMEMORY

The component allocation failed

Example:

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

Set objTagGroupFact = ParentObject.GetTechnologicalObject(“TagGroupFactory”)

Dim objTagGroup As TagGroup

Dim ModifyRef As Boolean

ModifyRef = FALSE

objTagGroupFact.CreateTagGroup “My_Group”, ModifyRef, ParentObject,

objTagGroup

Parameters:

• i_tag_group_name (str) –

• i_modify_reference (bool) –

• i_product (Product) –

• o_tag_group (TagGroup) –

Return type:

None

create_tag_group_in_doc(i_tag_group_name: str, o_tag_group: TagGroup) → None

Note

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

o Sub CreateTagGroupInDoc(CATBSTR iTagGroupName,

TagGroup oTagGroup)

Creates a TagGroup with the given name in the document.

Parameters:

iTagGroupName

Name of the TagGroup to be created.

oTagGroup

Created TagGroup.

Returns:

An HRESULT.

Legal values:

S_OK

Action is successfully created and the interface pointer is

successfully returned

E_FAIL

Action was successfully created, but the interface query

failed

E_NOINTERFACE

Action was successfully created, but the it doesn’t implement the

requested interface

E_OUTOFMEMORY

The component allocation failed

Example:

Set ParentObject = CATIA.ActiveDocument

Dim Fact As TagGroupFactory

Set Fact = ParentObject.GetItem(“DELMTagGroupFactory”)

Dim TagGrp As TagGroup

Fact.CreateTagGroupInDoc “ABC”, TagGrp

Parameters:

• i_tag_group_name (str) –

• o_tag_group (TagGroup) –

Return type:

None

delete_tag_group(i_tag_group: TagGroup) → TagGroup

Note

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

o Sub DeleteTagGroup(TagGroup iTagGroup)

Deletes a TagGroup

Parameters:

iTagGroup

TagGroup to be deleted

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

…

Dim objTagGroup(2) As TagGroup

Dim objTagGroupFactory as TagGroupFactory

…

objTagGroupFactory.DeleteTagGroup objTagGroup(1)

Parameters:

i_tag_group (TagGroup) –

Return type:

TagGroup

reparent_tag_group(i_tag_group: TagGroup, io_product: Product, i_modify_reference: bool) → TagGroup

Note

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

o Sub ReparentTagGroup(TagGroup iTagGroup,

Product ioProduct,

boolean iModifyReference)

Reparents a TagGroup

Parameters:

iTagGroup

TagGroup to be reparented.

ioProduct

The Product to which the TagGroup gets reparented

iModifyReference

Modify reference or modify locally.

Returns:

an HRESULT value.

Legal values:

S_OK if the operation succeeds

E_FAIL otherwise

Example:

…

Dim objTagGroup(2) As TagGroup

Dim objTagGroupFactory as TagGroupFactory

Dim objProd As Product

…

objTagGroupFactory.ReparentTagGroup objTagGroup(0), objProd,

TRUE

Parameters:

• i_tag_group (TagGroup) –

• io_product (Product) –

• i_modify_reference (bool) –

Return type:

TagGroup