pycatia.in_interfaces.selection_sets

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.in_interfaces.selection_sets.SelectionSets(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

SelectionSets

Interface to manage the Selection Sets in a document.

add_cso_into_selection_set(i_sel_set_name: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddCSOIntoSelectionSet(CATBSTR iSelSetName)

Adds CSO’s content in a Selection Set.

Parameters:

iSelSetName

The name of the Selection Set in wich the CSO has to be added.

Returns:

The error code of function :

S_OK if the content of the CSO is added

E_FAIL if the content of the CSO is not added

Parameters:

i_sel_set_name (str) –

Return type:

None

create_selection_set(i_sel_set_name: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub CreateSelectionSet(CATBSTR iSelSetName)

Creates a new Selection Set.

Role: This method creates a new Selection Set.

Parameters:

iSelSetName

The name of Selection Set to create.

Returns:

The error code of function :

S_OK if the Selection Set is created

E_FAIL if a problem occurred

Parameters:

i_sel_set_name (str) –

Return type:

None

delete_selection_set(i_sel_set_name: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub DeleteSelectionSet(CATBSTR iSelSetName)

Deletes a Selection Set.

Role: This method removes a Selection Set and all its

content.

Parameters:

iSelSetName

The Selection Set to delete.

Returns:

The error code of function :

S_OK if the method succeeded

E_FAIL if a problem occurred

Parameters:

i_sel_set_name (str) –

Return type:

None

get_list_of_selection_set(o_list_of_selection_set: tuple) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetListOfSelectionSet(CATSafeArrayVariant

oListOfSelectionSet)

Retrieves the list of Selection Sets in the document.

Parameters:

oListOfSelectionSet

The list of Selection Sets in the document

Returns:

The error code of function :

S_OK if the method succeeded

E_FAIL if an error occurred

Parameters:

o_list_of_selection_set (tuple) –

Return type:

None

put_selection_set_into_cso(i_sel_set_name: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub PutSelectionSetIntoCSO(CATBSTR iSelSetName)

Puts Selection Set’s content in the CSO.

Parameters:

iSelSetName

The name of the Selection Set to put in the CSO.

Returns:

The error code of function :

S_OK if the content of the Selection Set is added in the

CSO

E_FAIL if the content of the Selection Set is added in the

CSO

Parameters:

i_sel_set_name (str) –

Return type:

None

rename_selection_set(i_old_sel_set_name: str, i_new_sel_set_name: str) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RenameSelectionSet(CATBSTR iOldSelSetName,

CATBSTR iNewSelSetName)

Renames a Selection Set.

Parameters:

iOldSelSetName

The original name of the Selection Set.

iNewSelSetName

The new name of the Selection Set.

Returns:

The error code of function :

S_OK if the name is changed

E_FAIL if the name is not changed

Parameters:

• i_old_sel_set_name (str) –

• i_new_sel_set_name (str) –

Return type:

None