pycatia.eno_cd5_interfaces.cd5_structure

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.eno_cd5_interfaces.cd5_structure.CD5Structure(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
CD5Structure

Represents the structure of an ENOVIA V6 object.
Role: It represents the structure of an ENOVIA V6 root object on which it is
possible to include some sub components. Its final purpose is to perform a
Partial Open on it, showing only the root and the sub components that were
previously included. It is managed by CD5Engine.

See also:
CD5ID, CD5Engine
get_root() → CD5ID

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetRoot() As CD5ID

Returns the root ENOVIA V6 Identifier of the CD5Structure.

Returns:
The CD5ID.
Example:

The following example creates a Structure from “RootProduct” and gets
its root identifier.

Dim oCD5Engine As CD5Engine
Set oCD5Engine = CATIA.GetItem(“CD5Engine”)
Dim iRootCD5ID, oDummyCD5ID As CD5ID
Set iRootCD5ID = oCD5Engine.GetIDFromTNR(“CATProduct For Team”, “RootProduct”, “—“)
Dim oCD5Structure As CD5Structure
Set oCD5Structure = oCD5Engine.GetStructure(iRootCD5ID)
Set oDummyCD5ID = oCD5Structure.GetRoot()
Return type:

CD5ID

include(i_id: CD5ID) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Include(CD5ID iID)

Includes an sub component (identified by its ENOVIA V6 Identifier) for a
future Partial Open operation.

Parameters:

iID
The ENOIACD5ID of the sub component to include.

Example:

The following example creates a Structure from “RootProduct” and
includes the object “IncludedPart”.

Dim oCD5Engine As CD5Engine
Set oCD5Engine = CATIA.GetItem(“CD5Engine”)
Dim iRootCD5ID, iIncludedCD5ID As CD5ID
Set iRootCD5ID = oCD5Engine.GetIDFromTNR(“CATProduct For Team”, “RootProduct”, “—“)
Set iIncludedCD5ID = oCD5Engine.GetIDFromTNR(“CATProduct For Team”, “IncludedPart”, “—“)
Dim oCD5Structure As CD5Structure
Set oCD5Structure = oCD5Engine.GetStructure(iRootCD5ID)
oCD5Structure.Include(iIncludedCD5ID)
Parameters:

i_id (CD5ID) –

Return type:

None