SfmSlot (Object)

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

Methods


Func GetCntnDetailName() As
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
Sub GetCntnDetailParameters( oListOfSlotParameters, 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
Func GetConnectionCoordinate() As
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)
Func GetMasterObject() As
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
Func GetSlaveObject() As
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
Sub SetSlaveObject( 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)
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