pycatia.cat_str_functional_interfaces.sfm_positioning_strategy_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_positioning_strategy_manager.SFMPositioningStrategyManager(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
SfmPositioningStrategyManager

Gets CATIASfmPositioningStrategyManager.
Use this Manager to GetAvailablePositioningStrategies &
GetPositioningStrategyParams.

Example:
Get the Manager from factory.

‘Retrieve the Factory
Set Factory = part1.GetCustomerFactory(“SfmFunctionFactory”)
‘Retrieve the Position Strategy Manager
Dim ObjSfmPosStrategyMgr As
SfmPositioningStrategyManager
Set ObjSfmPosStrategyMgr = Factory.GetOpeningMgr(Part1, “SfmPositioningStrategyManager”)
get_available_positioning_strategies(o_list_strategy_names: tuple) → cat_variant

Note

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

Get The list of Available Position Strategies.

Parameters:

oListStrategyNames
[out] List of Strategies.

Returns:
S_OK if everything ran ok

Example:
Gets Available Positoning Strategies from Position Strategy
Manager.

‘Retrieve the Factory
Set Factory = part1.GetCustomerFactory(“SfmFunctionFactory”)
‘Retrieve the Position Strategy Manager
Dim ObjSfmPosStrategyMgr As
SfmPositioningStrategyManager
Set ObjSfmPosStrategyMgr = Factory.GetOpeningMgr(Part1, “SfmPositioningStrategyManager”)
‘Get The List of Available Strategies
Dim oListStrategies() As Variant
ObjSfmPosStrategyMgr.GetAvailablePositioningStrategies
oListStrategies
‘Display The List of Available Strategies
Dim NbOfStrategies As Long
NbOfStrategies = UBound(oListStrategies)
Display List of Strategies
For i = 0 To NbOfStrategies
MsgBox oListStrategies(i)
Next
Parameters:

o_list_strategy_names (tuple) –

Return type:

cat_variant

get_positioning_strategy_params(i_pos_strategy_name: str) → SFMStandardPosStrategyParameters

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPositioningStrategyParams(CATBSTR iPosStrategyName) As
SfmStandardPosStrategyParameters

Get The list of Available Position Strategies Parameters, depending on
Strategy Name. See CATIASfmStandardPosStrategyParameters for
details

Parameters:

iPosStrategyName
[in] Name of Strategy.
oListPosParams
[out] List of parameters.

Returns:
S_OK if everything ran ok

Example:
The Example Demonstrates how to get position strategy parameters
for “CATSfmPosMidDistMidDist”.

‘Retrieve the Factory
Set Factory = part1.GetCustomerFactory(“SfmFunctionFactory”)
‘Retrieve the Position Strategy Manager
Dim ObjSfmPosStrategyMgr As
SfmPositioningStrategyManager
Set ObjSfmPosStrategyMgr = Factory.GetOpeningMgr(Part1, “SfmPositioningStrategyManager”)
Dim PositionStrategyParms As
SfmStandardPosStrategyParameters
Set PositionStrategyParms = ObjSfmPosStrategyMgr.GetPositioningStrategyParams(“CATSfmPosMidDistMidDist”)
Parameters:

i_pos_strategy_name (str) –

Return type:

SFMStandardPosStrategyParameters