pycatia.funct_system_interfaces.functional_action

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_action.FunctionalAction(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

FunctionalAction

The interface to access a Functional Action.

property from_: FunctionalPosition

Note

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

o Property From() As FunctionalPosition

Get the From object.

Return type:

FunctionalPosition

get_facet(i_fm: FunctionalFacetMgr) → 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) → 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 group: FunctActionsGroup

Note

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

o Property Group() As FunctActionsGroup (Read Only)

Get the Group property.

Vary when adding/removing the action to/from a group.

Return type:

FunctActionsGroup

invert_direction() → None

Note

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

o Sub InvertDirection()

Invert the action’s Direction.

Fails if the action is included in a group.

Return type:

None

property orientation_direction: int

Note

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

o Property OrientationDirection() As

CATFunctOrientationDirection

Get the OrientationDirection property.

See also:

CATFunctOrientationDirection

Returns:

enum cat_funct_orientation_direction

Return type:

int

search_facet(i_fm: FunctionalFacetMgr, i_create_if_necessary: bool) → 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) → 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

property to: FunctionalPosition

Note

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

o Property To() As FunctionalPosition

Get the To object.

Return type:

FunctionalPosition