pycatia.product_structure_interfaces.publications

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.product_structure_interfaces.publications.Publications(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Publications

The collection of the Product publications.

A Product object can aggregate one or zero Publications

collection.

add(i_public_name: str) → Publication

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add(CATBSTR iPublicName) As Publication

Adds a publication object to the product and returns a pointer to the

publication object.

Parameters:

iPublicName

The name of the publication

oPub

The publication object

Example: The following example adds a new publication object with

the name “PubName” to the product and returns the publication object

Pub1.

Dim Prod1 As Product

Set Pub1 = Prod1.Add(PubName)

Parameters:

i_public_name (str) –

Return type:

Publication

item(i_identifier: cat_variant) → Publication

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIdentifier) As Publication

Returns the publication object corresponding to the given publication

name.

Parameters:

iIdentifier

The name of the publication

oPub

The publication object

Example: The following example returns Pub1 publication object from

the product referencing the published name PubId.

Dim Prod1 As Product

Set Pub1 = Prod1.Item(PubId)

Parameters:

i_identifier (cat_variant) –

Return type:

Publication

remove(i_identifier: str) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATBSTR iIdentifier)

Removes a publication from the product.

Parameters:

iIdentifier

The name of the publication

Example: The following example removes the publication object

corresponding to the name PubId.

Dim Prod1 As Product

Prod1.Remove(PubId)

Parameters:

i_identifier (str) –

Return type:

None

set_direct(i_identifier: cat_variant, i_pointed: Reference) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDirect(CATVariant iIdentifier,

Reference iPointed)

Valuates a publication object directly with the object it

publishes.

Parameters:

iIdentifier

The name of the publication

iPointed

The published object

The following

Boundary objects is supported: Boundary

Example: The following example valuates the publication object of

product Prod1 having the name PubId with the reference object

RefObject.

Dim Prod1 As Product

Prod1.SetDirect(PubId,RefObject)

Parameters:

• i_identifier (cat_variant) –

• i_pointed (Reference) –

Return type:

None

set_relay(i_identifier: cat_variant, i_relayer: Publications, i_name_in_relay: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetRelay(CATVariant iIdentifier,

Publications iRelayer,

CATVariant iNameInRelay)

Valuates a publication object with another publication

object.

Parameters:

iIdentifier

The name of the publication to be valuated

iRelayer

The product aggregating the valuating intermediate publication

object

iNameInRelay

The name of the valuating publication object

Example: The following example valuates the publication object of

product Prod1 having the name PubId1 with the publication object of product

Prod2 having the name PubId2.

Dim Prod1 As Product

Prod1.SetRelay(PubId1,Prod2,PubId2)

Parameters:

• i_identifier (cat_variant) –

• i_relayer (Publications) –

• i_name_in_relay (cat_variant) –

Return type:

None