pycatia.cat_str_functional_interfaces.sfm_endcut

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.SFMEndcut(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
SfmEndcut

Interface to manage the EndCut on Super Profile.
Role: Allows managing (mainly retreiving parameters)on existing
EndCut.

See also:
SfmProfile, SfmEndcutManager, SfmConnectionParameters
get_connection_coordinate() → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetConnectionCoordinate() As CATSafeArrayVariant

Gets thelocation of existing endcut.

Parameters:

oCoordinate
[out] The Coordinates.

Returns:
S_OK if everything ran ok

Example
:
The example retrieves endcut Coordinates defined on start
end.

Dim EndcutObj As SfmEndcut
Set EndcutObj = StiffObj.GetEndcut(1)
Dim Coord() As Variant
Dim x,y,z as Double
Coord() = EndcutObj.GetConnectionCoordinate
x = Coord(0)
y = Coord(1)
z = Coord(2)
Return type:

tuple

get_endcutinfo(o_type_of_endcut: str, o_name_of_endcut: str, o_list_of_endcut_contexts: SFMReferences, o_list_of_endcut_params: SFMConnectionParameters, o_list_of_end_cut_param_names: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetEndcutinfo(CATBSTR oTypeOfEndcut,
CATBSTR oNameOfEndcut,
SfmReferences oListOfEndcutContexts,
SfmConnectionParameters oListOfEndcutParams,
CATSafeArrayVariant oListOfEndCutParamNames)

Gets the information on existing Endcut.

Parameters:

oTypeOfEndcut
[out] Type of Endcut(Snipe,Trim,Weld).
oNameOfEndcut
[out] Name of the Endcut.
oListOfEndcutContexts
[out] List of Contexts (Limits) defined for Cutbacks and Contextual
Endcuts. The list will be empty for custom UDF based endcuts.

oListOfEndcutParams
[out] List of Parameters set when defining the Endcut.

oListOfEndCutParamNames
[out] List of Parameter Names set when defining the Endcut.


Returns:
S_OK if everything ran ok

Example
:
The example retrieves endcut information.

Dim EndcutObj As SfmEndcut
Set EndcutObj = StiffObj.GetEndcut(1)
Dim EndCutName, EndCutType As String
Dim ContextList As SfmReferences
Dim ParamList As SfmConnectionParameters
Dim ParamNamesList() As Variant
EndcutObj.GetEndcutinfo EndCutType, EndCutName, ContextList,
ParamList, ParamNamesList
Parameters:

  • o_type_of_endcut (str) –

  • o_name_of_endcut (str) –

  • o_list_of_endcut_contexts (SFMReferences) –

  • o_list_of_endcut_params (SFMConnectionParameters) –

  • o_list_of_end_cut_param_names (tuple) –

Return type:

cat_variant

update_connections_set() → None

Note

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

Updates the Connection Set.

Returns:
S_OK if everything ran ok

Example
:
The example Updates the Connection Set.

Dim EndcutObj As SfmEndcut
Set EndcutObj = StiffObj.GetEndcut(1)
EndcutObj.UpdateConnectionsSet
Return type:

None