pycatia.cat_str_functional_interfaces.sfm_slot

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_slot.SFMSlot(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
SfmSlot

Interface to Get and Set inputs to existing Slot.
Role: Allows managing (mainly retreiving parameters)Slots.

See also:
SfmProfile, SfmSuperPlate, SfmSlots, SfmConnectionParameters
get_cntn_detail_name() → str

Note

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

Gets the name of the UDF used for creating the slot.

Parameters:

oUDFName
[in] Name of the UDF.

Returns:
S_OK if everything ran ok

Example:
This example gives the name of the UDF used in creating the
slot.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
Dim UDFName As String
UDFName = SlotObj.GetCntnDetailName
Return type:

str

get_cntn_detail_parameters(o_list_of_slot_parameters: SFMConnectionParameters, o_list_of_parameter_names: tuple) → cat_variant

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetCntnDetailParameters(SfmConnectionParameters
oListOfSlotParameters,
CATSafeArrayVariant oListOfParameterNames)

Gets the Information on Existing Slot.

Parameters:

oListOfSlotParameters
[out] List of SfmConnectionParameters.
oListOfParameterNames
[out] List of Parameter Names set.

Returns:
S_OK if everything ran ok

Example:
This retrieves the Parameter List and Parameter Names and checks
values assigned to these parameters.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
Dim oListSlotParams As SfmConnectionParameters
Dim ListOfParamNames() As Variant
SlotObj.GetCntnDetailParametersoListSlotParams,ListOfParamNames
Dim UDFParam As Parameter
ParamCount = oListSlotParams.Count
Dim Value As String
For i = 1 To ParamCount
Set UDFParam = oListSlotParams.Item(i)
Value = UDFParam.ValueAsString
Next
Parameters:
Return type:

cat_variant

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 slot.

Parameters:

oCoordinate
[out] The Coordinates.

Returns:
S_OK if everything ran ok

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

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
Dim Coord() As Variant
Dim x,y,z as Double
Coord() = SlotObj.GetConnectionCoordinate
x = Coord(0)
y = Coord(1)
z = Coord(2)
Return type:

tuple

get_master_object() → Reference

Note

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

Gets the Penetrating Element used in the creation of the
Slot.

Parameters:

oPenetratingObject
[out] The retrieved element(Profile).

Returns:
S_OK if everything ran ok

Example:
This example gets the Master Object.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
Dim oPenetratingRef As Reference
Set oPenetratingRef = SlotObj.GetMasterObject
Return type:

Reference

get_slave_object() → Reference

Note

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

Gets the Penetrated Element used in the creation of the
Slot.

Parameters:

oPenetratedObject
[out] The retrieved element(Plate/Profile).

Returns:
S_OK if everything ran ok

Example:
This example gets the Slave Object.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
Dim oPenetratedRef As Reference
Set oPenetratedRef = SlotObj.GetSlaveObject
Return type:

Reference

set_slave_object(i_slave_object: Reference) → None

Note

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

Sets/Replaces the Penetrated Element used in the creation of the
Slot.

Parameters:

iSlaveObject
[in] The retrieved element(Plate/Profile).

Returns:
S_OK if everything ran ok

Example:
This example sets the Slave Object.

Dim SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
Dim oPenetratedRef As Reference
Set oPenetratedRef = PartObj.CreateReferenceFromObject(SfmNewPlateObj)
SlotObj.SetSlaveObject(oPenetratedRef)
Parameters:

i_slave_object (Reference) –

Return type:

None

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 SlotsonPlate As SfmSlots
Set SlotsonPlate = SfmSuperPlateObj.GetSlotsOnPlate
Dim SlotObj As SfmSlot
Set SlotObj = SlotsonPlate.Item(1)
SlotObj.UpdateConnectionsSet
Return type:

None