pycatia.cat_str_functional_interfaces.sfm_slots

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_slots.SFMSlots(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
SfmSlots

Interface to create, remove and access existing slot.
Role: Allows creating,removing and accessing slot object.

See also:
SfmSlots, SfmSuperPlate, SfmProfile, SfmConnectionParameters
add_slot(i_penetrated_element: Reference, i_penetrating_object: Reference, i_slot_name: str, i_list_parameters: SFMConnectionParameters) → SFMSlot

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddSlot(Reference iPenetratedElement,
Reference iPenetratingObject,
CATBSTR iSlotName,
SfmConnectionParameters iListParameters) As SfmSlot

Creates a New Slot.

Parameters:

iPenetratedElement
[in] Object on which slot will be created(Plate/Profile).

iPenetratingObject
[in] Object using which slot will be created(Profile).

iSlotName
[in] Slot Name.
iListParameters
[in] List of UDF parameters.
oSfmSlot
[out] Created Slot.

Returns:
S_OK if everything ran ok

Example:
This example creates a new Slot on Plate.

Dim PenetratedRef, PenetratingRef As Reference
Set PenetratedRef = PartObj.CreateReferenceFromObject(SfmSuperPlateObj)
Set PenetratingRef = PartObj.CreateReferenceFromObject(SfmSuperStiffenerObj)
Dim SlotFactory As SfmOperationFactory
Set SlotFactory = PartObj.GetCustomerFactory(“SfmOperationFactory”)
Dim oListSlotParams As SfmConnectionParameters
Dim oListSlotPramNames() As Variant
SlotFactory.GetSlotParameters SfmSuperStiffenerObj,
“Tee_Slot_thru_Plate”, oListSlotParams,
oListSlotPramNames
Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim NewSlot As SfmSlot
Set NewSlot = SlotsonPlate.AddSlot(PenetratedRef, PenetratedRef, “Tee_Slot_thru_Plate”, oListSlotParams, oListSlotPramNames)
Parameters:
Return type:

SFMSlot

item(i_index: cat_variant) → SFMSlot

Note

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

Gets existing Slot.

Parameters:

iIndex
[in] Index of the Slot to be retrieved.
oSfmSlot
[out] The retrieved slot.

Returns:
S_OK if everything ran ok

Example:
This example gets existing slot on a Plate.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim CntSlotsOnPlate As Long
CntSlotsOnPlate = SlotsonPlate.Count
Dim SlotObj As SfmSlot
For i = 1 To CntSlotsOnPlate
Set SlotObj = SlotsonPlate.Item(i)
Next
Parameters:

i_index (cat_variant) –

Return type:

SFMSlot

remove_slot(i_sfm_slot: SFMSlot) → None

Note

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

Removes Existing Slot.

Parameters:

iSfmSlot
[in] Slot to be removed.

Returns:
S_OK if everything ran ok

Example:
This example removes existing slot on a Plate.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
SlotsonPlate.RemoveSlot(SlotObj)
Parameters:

i_sfm_slot (SFMSlot) –

Return type:

None