pycatia.funct_system_interfaces.functional_objects

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_objects.FunctionalObjects(com_object, child_object=<class 'pycatia.funct_system_interfaces.functional_object.FunctionalObject'>)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
FunctionalObjects

Interface to access a collection of FunctionalObjects.
create(i_name: str) → FunctionalObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Create(CATBSTR iName) As FunctionalObject

Creates a FunctionalObject.
Parameters:

i_name (str) –

Return type:

FunctionalObject

create_proxy(i_name: str, i_desc: FunctionalDescription) → FunctionalObjectProxy

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CreateProxy(CATBSTR iName,
FunctionalDescription iDesc) As FunctionalObjectProxy

Creates a FunctionalObjectProxi.
Parameters:
Return type:

FunctionalObjectProxy

delete(i_object: FunctionalObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Delete(FunctionalObject iObject)

Deletes a FunctionalObject.
Parameters:

i_object (FunctionalObject) –

Return type:

None

elem(i_index: cat_variant) → FunctionalObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Elem(CATVariant iIndex) As FunctionalObject

Returns an action using its index or its name from the actions
collection.

Parameters:

iIndex
The index or the name of the action to retrieve from the collection
of actions. As a numerics, this index is the rank of the action in the
collection. The index of the first action in the collection is 1, and the index
of the last action is Count. As a string, it is the name you assigned to the
action using the

AnyObject.Name property.
Returns:
The retrieved action
Example:
This example retrieves in Obj1 the fifth object in the collection and
in Obj2 the action named Valve.

Dim Obj1 As FunctionalObject
Set Obj1 = Desc.Object(5)
Dim Obj2 As FunctionalObject
Set Obj2 = Desc.Object(“Valve”)
Parameters:

i_index (cat_variant) –

Return type:

FunctionalObject