SfmSuperPlate (Object)

Interface to manage the Structure Functional Modeler SuperPlate object.
Role: Allows accessing and setting of SuperPlate's data.
See also:

Properties


Property LimitMode() As
Returns or sets the SuperPlate's limit mode.
Example
:
This example retrieves in LimitMode the limit mode of the SuperPlate feature. 
 Dim LimitMode As Integer
 Set LimitMode = SuperPlate.LimitMode
Property MoldedSurface() As (Read Only)
Returns the molded surface.
Example
:
This example retrieves in MoldedSurface the molded surface for the SuperPlate feature. 
 Dim MoldedSurface As Reference
 Set MoldedSurface = SuperPlate.MoldedSurface
Property SplitPlates() As (Read Only)
Returns the SplitPlates.
Example
:
This example retrieves in SplitPlates the list of SplitPlates for the SuperPlate feature. 
 Dim SplitPlates As References
 Set SplitPlates = SuperPlate.SplitPlates
Property SplitPlatesObjects() As (Read Only)
Returns the SplitPlates.
Example
:
This example retrieves in SplitPlates the list of SplitPlates for the SuperPlate feature. 
 Dim SuperPlate2 As SfmSuperPlate
 Set SuperPlate2 = SuperPlates.Item(2)
 Dim OperatedSuperPlateObject  As SfmSuperPlateObject
 Set OperatedSuperPlateObject = SuperPlate2.GetItem("SfmSuperPlateObject")
 Dim SplitPlates As SplitPlatesObjects
 Set SplitPlates = SuperPlate.SplitPlatesObjects
Property Support() As
Returns the SuperPlate's support.
Example
:
This example retrieves in Support the support of the SuperPlate feature. 
 Dim Support As Reference
 Set Support = SuperPlate.Support
Property SupportOffset() As
Returns or sets the SuperPlate's support offset.
Example
:
This example retrieves in Offset the support offset of the SuperPlate feature. 
 Dim Offset As Double
 Set Offset = SuperPlate.SupportOffset
Property SupportOffsetParam() As (Read Only)
Property Thickness() As
Returns or sets the SuperPlate's Thickness.
Example
:
This example retrieves the Thickness of existing SuperPlate. 
 Dim ThicknessValue As Double
 Set ThicknessValue = SuperPlate.Thickness

Methods


Sub AddLimit( iLimit, iOrientation)
Adds one object to the list of connected object.
Parameters:
iLimit
[in] New Limit to add.
iOrientation
[in] iOrientation value can be selected from InvertOrientation = -1, UnknownOrientation = 0, SameOrientation = 1, GlobalOrientation(Xp) = 2, GlobalOrientation(Xm) = 3, GlobalOrientation(Yp) = 4, GlobalOrientation(Ym) = 5, GlobalOrientation(Zp) = 6, GlobalOrientation(Zm) = 7, GlobalOrientation_Inside = 8, [SameOrientation ] GlobalOrientation_Outside = 9, [InvertOrientation ] GlobalOrientation_LInboard = 10 [Toward center line] GlobalOrientation_LOutboard = 11 [Opposite of previous one ] GlobalOrientation_TInboard = 12 [Toward midship ] GlobalOrientation_TOutboard = 13 [Opposite of previous one]
Example
:
This example adds one limit to Deck Plate, and keeps Fore Side. 
 Set PlateLimit = ObjPart.FindObjectByName("CROSS.60")
 Dim LimitRef As Reference
 Set LimitRef = ObjPart.CreateReferenceFromObject(PlateLimit)
 Dim Orientation As Long
 Orientation = 2
 SuperPlate.AddLimit LimitRef, Orientation
Func GetFreeEdges() As
Returns the Free Edges of Super Plate.
Example
:
This example retrieves in FreeEdges the list of free edges for the SuperPlate feature. 
  
Dim FreeEdges As References
Set FreeEdges = SuperPlate.GetFreeEdges
Func GetSlotsOnPlate() As
Retrieves Slots on Plate.
Parameters:
oSfmSlots
[out] Slots.
Returns:
S_OK if everything ran ok
Example
:
This example gets the Slots. 
 Dim SlotsonPlate As SfmSlots
 Set SlotsonPlate = PlateObj.GetSlotsOnPlate
Sub GetSplitPlateAttributes( iSplitPlateNumber, oThickness, oMaterialName, oGradeName)
Returns the SplitPlate(ChildPlate) Attributes(Thickness,Material,Grade).
Parameters:
iSplitPlateNumber
[in] This Number is the Split Plate number desired.
oThickness
[out] Thickness of the child Plate.
oMaterialName
[out] Material of the child Plate.
oGradeName
[out] Grade of the child Plate.
Example
:
This example retrieves the attributes of the ChildPlate. 
 'Retrieve the Split Plates under the SuperPlate
 Dim SplitPlates as References
 Set SplitPlates = SuperPlateObj.SplitPlates
 Dim SplitPlate1 As Reference
 Set SplitPlate1 = SplitPlates.Item(1)
 'Add the Split Plate to Selection
 Set SelctionObj = CATIA.ActiveDocument.Selection
 SelctionObj.Add SplitPlate1
 'Retrieve the Split Plate From Selection
 Dim SplitPlateObj As SfmSuperPlate
 Set SplitPlateObj = SelctionObj.FindObject("CATIASfmSuperPlate")
 Dim Thickness As Double
 Dim Material As String
 Dim Grade As String    
 SplitPlateObj.GetSplitPlateAttributes 1, Thickness ,Material ,Grade
Sub InvertLimit( iIndex)
Invert a limit orientation by its index or its name.
Example
:
This example removes the first object from the list of connected objects for the StfConnection feature. 
 StfConnection.RemoveObject 1
Sub LimitOrientations( ioOrientations)
Returns the orientation of the limits.
Example
:
This example retrieves in Orientations the list of orientations limit for the SuperPlate feature. 
 Dim Orientations As References
 SuperPlate.LimitOrientations Orientations
Func Limits() As
Returns the limits.
Example
:
This example retrieves in Limits the list of limits for the SuperPlate feature. 
 Dim Limits As References
 SuperPlate.Limits Limits, Orientations
Sub RemoveLimit( iIndex)
Removes one object from the list of limits by its index or its name.
Example
:
This example removes the first object from the list of connected objects for the StfConnection feature. 
 StfConnection.RemoveObject 1
Sub Run()
Build the SplitPlates.
Example
:
This example build the SplitPlates for the SuperPlate feature. 
 SuperPlate.Run
Sub SetAsLastLimit( iIndex)
Adds one limit at the end of the list.
Example
:
This example sets the limit at the end of the list of limits. 
 SuperPlate.SetAsLastLimit Index
Sub SetSplitPlateAttributes( iSplitPlateNumber, iThickness, iMaterialName, iGradeName)
Set the SplitPlate(ChildPlate) Attributes(Thickness,Material,Grade).
Parameters:
iSplitPlateNumber
[in] iSplitPlateNumber will be 1,2,3...
iThickness
[in] Thickness of the child Plate.
iMaterialName
[in] Material of the child Plate.
iGradeName
[in] Grade of the child Plate.
Example
:
This example sets the attributes of the ChildPlate. 
 'Retrieve the Split Plates under the SuperPlate
 Dim SplitPlates as References
 Set SplitPlates = SuperPlateObj.SplitPlates
 Dim SplitPlate1 As Reference
 Set SplitPlate1 = SplitPlates.Item(1)
 'Add the Split Plate to Selection
 Set SelctionObj = CATIA.ActiveDocument.Selection
 SelctionObj.Add SplitPlate1
 'Retrieve the Split Plate From Selection
 Dim SplitPlateObj As SfmSuperPlate
 Set SplitPlateObj = SelctionObj.FindObject("CATIASfmSuperPlate")
 SplitPlateObj.SetSplitPlateAttributes 1, 30, "Steel", "A45"