pycatia.cat_str_functional_interfaces.sfm_endcut_manager

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.cat_str_functional_interfaces.sfm_endcut_manager.SFMEndcutManager(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
SfmEndcutManager

Interface to get information on available endcuts from
catalog.
Role: Allows to see avaiable endcuts and their reuired inputs.
get_available_endcuts(i_section_family: str, i_endcut_type: str) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAvailableEndcuts(CATBSTR iSectionFamily,
CATBSTR iEndcutType) As CATSafeArrayVariant

Gets the list of available endcuts for a given family and type from the
catalog.

Parameters:

iSectionFamily
[in] The name of the Section Family(Tee,Angle,Bulb).

iType
[in] The Type of Endcut(Snipe,Trim,Weld).
oListEndcutNames
[out] A list of the available Endcuts.

Returns:
S_OK if everything ran ok

Example:
This Example retrieves the list of avaliable Endcuts for Tee
ProfileType and Snipe EndcutType.

Dim FactoryObj As SfmOperationFactory
Set FactoryObj = PartObj.GetCustomerFactory(“SfmOperationFactory”)
Dim EndCutManagerObj As SfmEndcutManager
Set EndCutManagerObj = FactoryObj.GetEndcutManager
Dim ListOfEndCutNames() As Variant
ListOfEndCutNames = EndCutManagerObj.GetAvailableEndcuts(“Tee”, “Snipe”)
Parameters:

  • i_section_family (str) –

  • i_endcut_type (str) –

Return type:

tuple

get_endcut_specifications(i_section_family: str, i_endcut_type: str, i_endcut_name: str, o_list_of_context_names: tuple, o_list_end_cut_parameters: SFMConnectionParameters, o_list_of_end_cut_param_names: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetEndcutSpecifications(CATBSTR iSectionFamily,
CATBSTR iEndcutType,
CATBSTR iEndcutName,
CATSafeArrayVariant oListOfContextNames,
SfmConnectionParameters oListEndCutParameters,
CATSafeArrayVariant oListOfEndCutParamNames)

Gets the Specifications required to define a particular
Endcut.

Parameters:

iSectionFamily
[in] The Section Family(Tee,Angle,Bulb).
iEndcutType
[in] The EndcutType(Snipe,Trim,Weld).
iEndcutName
[in] The Name of the Endcut sought from GetAvailableEndcuts Method.

oListOfContextNames
[out] The Limit Names for the Endcut(Cutbacks & Contextual only).
The List will be empty for Cutom Endcut.
oListEndCutParameters
[out] A list of Parameters published by the UDF. The default values
can be read using this output.
oListOfEndCutParamNames
[out] A list of Parameter Names published by the UDF.

Returns:
S_OK if everything ran ok

Example:
This Example retrieves the list of avaliable Endcuts for Tee
ProfileType and Snipe EndcutType.

Dim FactoryObj As SfmOperationFactory
Set FactoryObj = PartObj.GetCustomerFactory(“SfmOperationFactory”)
Dim EndCutManagerObj As SfmEndcutManager
Set EndCutManagerObj = FactoryObj.GetEndcutManager
Dim ListOfContextNames, ListOfUDFParamNames As
Variant
Dim ListOfUDFParameters As
SfmConnectionParameters
EndCutManagerObj.GetEndcutSpecifications “Tee”, “Snipe”,
“T-CTX-PLATE”, ListOfContextNames, ListOfUDFParameters,
ListOfUDFParamNames
Parameters:

  • i_section_family (str) –

  • i_endcut_type (str) –

  • i_endcut_name (str) –

  • o_list_of_context_names (tuple) –

  • o_list_end_cut_parameters (SFMConnectionParameters) –

  • o_list_of_end_cut_param_names (tuple) –

Return type:

None