pycatia.cat_plant_ship_interfaces.psp_app_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.cat_plant_ship_interfaces.psp_app_factory.PSPAppFactory(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

PspAppFactory

Represents the application factory.

Role: To create, instanciate, delete and query groups, logical lines,

compartments and parts.

create_group(i_current_product: Product, i_group_type: str, i_group_id: str) → PSPGroup

Note

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

o Func CreateGroup(Product iCurrentProduct,

CATBSTR iGroupType,

CATBSTR iGroupID) As PspGroup

Creates a group in the current Product.

Parameters:

iCurrentProduct

The current Product to query.

iGroupType

Group Startup type.

iGroupID

Group ID. A default ID will be generated if input is NULL.

Returns:

Created Group instance.

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim iStrVar2 As String

Dim iStrVar3 As String

Dim iObj4 As PspGroup

…

Set iObj4=objThisIntf.CreateGroup (iobj1,iStrVar2,iStrVar3

)

Parameters:

• i_current_product (Product) –

• i_group_type (str) –

• i_group_id (str) –

Return type:

PSPGroup

delete_compartment(i_compartment: PSPGroup) → None

Note

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

o Sub DeleteCompartment(PspGroup iCompartment)

Delete a compartment instance.

Parameters:

iCompartment

Compartment to be deleted

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As PspGroup

…

objThisIntf.DeleteCompartment iobj1

Parameters:

i_compartment (PSPGroup) –

Return type:

None

delete_group(i_group: PSPGroup) → None

Note

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

o Sub DeleteGroup(PspGroup iGroup)

Delete a group.

Parameters:

iGroup

Group to be deleted.

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As PspGroup

…

objThisIntf.DeleteGroup iobj1

Parameters:

i_group (PSPGroup) –

Return type:

None

delete_logical_line(i_logical_line: PSPLogicalLine) → None

Note

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

o Sub DeleteLogicalLine(PspLogicalLine iLogicalLine)

Delete a logical line instance.

Parameters:

iLogicalLine

Logical Line to be deleted

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As PspLogicalLine

…

objThisIntf.DeleteLogicalLine iobj1

Parameters:

i_logical_line (PSPLogicalLine) –

Return type:

None

delete_part(i_part: Product) → None

Note

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

o Sub DeletePart(Product iPart)

Delete a part.

Parameters:

iProduct

Part to be deleted.

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

…

objThisIntf.DeletePart iobj1

Parameters:

i_part (Product) –

Return type:

None

get_compartment(i_current_product: Product, i_compartment_id: str) → PSPGroup

Note

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

o Func GetCompartment(Product iCurrentProduct,

CATBSTR iCompartmentID) As PspGroup

Instanciate a compartment from the catalog into the current

Product.

Parameters:

iCurrentProduct

The current Product into which a compartment will be instanciated.

iCompartmentID

Compartment ID to get from the compartment catalog.

Returns:

Compartment instance.

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim iStrVar2 As String

Dim iObj3 As PspGroup

…

Set iObj3=objThisIntf.GetCompartment (iobj1,iStrVar2

)

Parameters:

• i_current_product (Product) –

• i_compartment_id (str) –

Return type:

PSPGroup

get_logical_line(i_current_product: Product, i_logical_line_id: str) → PSPLogicalLine

Note

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

o Func GetLogicalLine(Product iCurrentProduct,

CATBSTR iLogicalLineID) As PspLogicalLine

Returns a PspLogicalLine Logical line Instance.

Parameters:

iCurrentProduct

The current Product into which a logical line will be instanciated.

iLogicalLineID

Logical line ID to get from the logical line catalog.

Returns:

Logical line instance.

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim iStrVar2 As String

…

objThisIntf.GetLogicalLine (iobj1,iStrVar2 )

Parameters:

• i_current_product (Product) –

• i_logical_line_id (str) –

Return type:

PSPLogicalLine

list_compartments(i_current_product: Product) → PSPListOfObjects

Note

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

o Func ListCompartments(Product iCurrentProduct) As

PspListOfObjects

Retrieves a list of Compartments in the current Product.

Parameters:

iCurrentProduct

The current Product to query.

Returns:

A list of Compartmemts ( A list of CATIAPspGroup)

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim objArg2 As PspListOfObjects

…

Set ObjArg2 = objThisIntf.ListCompartments (iobj1 )

Parameters:

i_current_product (Product) –

Return type:

PSPListOfObjects

list_groups(i_current_product: Product) → PSPListOfObjects

Note

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

o Func ListGroups(Product iCurrentProduct) As

PspListOfObjects

Retrieve a list of Groups in the current Product.

Parameters:

iCurrentProduct

The current Product to query..

Returns:

A list of Groups ( A list of CATIAPspGroup)

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim objArg2 As ListOfObjects

…

Set ObjArg2 = objThisIntf.ListGroups (iobj1)

Parameters:

i_current_product (Product) –

Return type:

PSPListOfObjects

list_logical_lines(i_current_product: Product) → PSPListOfObjects

Note

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

o Func ListLogicalLines(Product iCurrentProduct) As

PspListOfObjects

Returns a list of logical lines in the current Product.

Parameters:

iCurrentProduct

The current Product to query..

Returns:

A list of logical Lines (A list of PspLogicalLine)

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim objArg2 As PspListOfObjects

…

Set ObjArg2 = objThisIntf.ListLogicalLines (iobj1 )

Parameters:

i_current_product (Product) –

Return type:

PSPListOfObjects

list_physicals(i_current_product: Product, i_domain_id: int) → PSPListOfObjects

Note

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

o Func ListPhysicals(Product iCurrentProduct,

CatPspIDLDomainID iDomainID) As PspListOfObjects

Returns a list of Physical objects in the node.

Parameters:

iCurrentProduct

The current Product to query.

iDomainID

Physical objects that have this domain ID. To get list of all in

all domains set iDomainID= catPspIDLNone.

Returns:

A list of physical objects (A list of PspPhysical objects)

Example:

Dim objThisIntf As PspAppFactory

Dim iobj1 As Product

Dim iobjArg2 As CatPspIDLDomainID

Dim objArg3 As PspListOfObjects

…

Set ObjArg3 = objThisIntf.ListPhysicals (iobj1, iobjArg2 )

Parameters:

• i_current_product (Product) –

• i_domain_id (int) – enum cat_psp_idl_domain_id

Return type:

PSPListOfObjects