pycatia.funct_system_interfaces.functional_description

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.funct_system_interfaces.functional_description.FunctionalDescription(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

CATFunctSystemItf.FunctionalElement

FunctionalDescription

The interface to access a Functional Description.

property actions: pycatia.funct_system_interfaces.functional_actions.FunctionalActions

Note

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

o Property Actions() As FunctionalActions (Read Only)

Get the Actions collection.

Return type

FunctionalActions

property actions_groups: pycatia.funct_system_interfaces.funct_actions_groups.FunctActionsGroups

Note

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

o Property ActionsGroups() As FunctActionsGroups (Read Only)

Get the ActionsGroups collection.

Return type

FunctActionsGroups

create_position(i_x: float, i_y: float) → pycatia.funct_system_interfaces.functional_position.FunctionalPosition

Note

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

o Func CreatePosition(double iX,

double iY) As FunctionalPosition

Create a Position.

To create actions pointing to NULL

Parameters

• i_x (float) –

• i_y (float) –

Return type

FunctionalPosition

get_facet(i_fm: pycatia.funct_system_interfaces.functional_facet_mgr.FunctionalFacetMgr) → pycatia.funct_system_interfaces.functional_facet.FunctionalFacet

Note

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

o Func GetFacet(FunctionalFacetMgr iFM) As FunctionalFacet

Returns the Facet.

Parameters

i_fm (FunctionalFacetMgr) –

Return type

FunctionalFacet

get_facet_by_name(i_fm: str) → pycatia.funct_system_interfaces.functional_facet.FunctionalFacet

Note

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

o Func GetFacetByName(CATBSTR iFM) As FunctionalFacet

Returns the Facet.

Parameters

i_fm (str) –

Return type

FunctionalFacet

property objects: pycatia.funct_system_interfaces.functional_objects.FunctionalObjects

Note

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

o Property Objects() As FunctionalObjects (Read Only)

Get the Objects collection.

Return type

FunctionalObjects

search_facet(i_fm: pycatia.funct_system_interfaces.functional_facet_mgr.FunctionalFacetMgr, i_create_if_necessary: bool) → pycatia.funct_system_interfaces.functional_facet.FunctionalFacet

Note

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

o Func SearchFacet(FunctionalFacetMgr iFM,

boolean iCreateIfNecessary) As FunctionalFacet

Searches the Facet.

Parameters

• i_fm (FunctionalFacetMgr) –

• i_create_if_necessary (bool) –

Return type

FunctionalFacet

search_facet_by_name(i_fm: str, i_create_if_necessary: bool) → pycatia.funct_system_interfaces.functional_facet.FunctionalFacet

Note

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

o Func SearchFacetByName(CATBSTR iFM,

boolean iCreateIfNecessary) As FunctionalFacet

Searches the Facet.

Parameters

• i_fm (str) –

• i_create_if_necessary (bool) –

Return type

FunctionalFacet

unlock() → None

Note

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

o Sub Unlock()

Unlock.

To remove the protection against modifications.

Return type

None

property variants: FunctionalVariants

Note

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

o Property Variants() As FunctionalVariants (Read Only)

Get the Variants collection.

(gives a NULL pointer if the description is a itself variant)

Return type

FunctionalVariants