pycatia.cat_str_functional_interfaces.sfm_super_plate

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_super_plate.SFMSuperPlate(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

CATStrFunctionalInterfaces.SfmObject

SfmSuperPlate

Interface to manage the Structure Functional Modeler SuperPlate

object.

Role: Allows accessing and setting of SuperPlate’s data.

See also:

SfmFactory

add_limit(i_limit: Reference, i_orientation: int) → None

Note

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

o Sub AddLimit(Reference iLimit,

long 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

Parameters:

• i_limit (Reference) –

• i_orientation (int) –

Return type:

None

get_free_edges() → References

Note

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

o Func GetFreeEdges() As References

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

Return type:

References

get_slots_on_plate() → SFMSlots

Note

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

o Func GetSlotsOnPlate() As SfmSlots

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

Return type:

SFMSlots

get_split_plate_attributes(i_split_plate_number: int, o_thickness: float, o_material_name: str, o_grade_name: str) → None

Note

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

o Sub GetSplitPlateAttributes(long iSplitPlateNumber,

double oThickness,

CATBSTR oMaterialName,

CATBSTR 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

Parameters:

• i_split_plate_number (int) –

• o_thickness (float) –

• o_material_name (str) –

• o_grade_name (str) –

Return type:

None

invert_limit(i_index: cat_variant) → None

Note

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

o Sub InvertLimit(CATVariant 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

Parameters:

i_index (cat_variant) –

Return type:

None

property limit_mode: int

Note

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

o Property LimitMode() As long

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

Return type:

int

limit_orientations(io_orientations: tuple) → None

Note

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

o Sub LimitOrientations(CATSafeArrayVariant 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

Parameters:

io_orientations (tuple) –

Return type:

None

limits() → References

Note

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

o Func Limits() As References

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

Return type:

References

property molded_surface: Reference

Note

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

o Property MoldedSurface() As Reference (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

Return type:

Reference

remove_limit(i_index: cat_variant) → None

Note

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

o Sub RemoveLimit(CATVariant 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

Parameters:

i_index (cat_variant) –

Return type:

None

run() → None

Note

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

o Sub Run()

Build the SplitPlates.

Example:

This example build the SplitPlates for the SuperPlate

feature.

SuperPlate.Run

Return type:

None

set_as_last_limit(i_index: cat_variant) → None

Note

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

o Sub SetAsLastLimit(CATVariant 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

Parameters:

i_index (cat_variant) –

Return type:

None

set_split_plate_attributes(i_split_plate_number: int, i_thickness: float, i_material_name: str, i_grade_name: str) → None

Note

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

o Sub SetSplitPlateAttributes(long iSplitPlateNumber,

double iThickness,

CATBSTR iMaterialName,

CATBSTR 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”

Parameters:

• i_split_plate_number (int) –

• i_thickness (float) –

• i_material_name (str) –

• i_grade_name (str) –

Return type:

None

property split_plates: References

Note

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

o Property SplitPlates() As References (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

Return type:

References

property split_plates_objects: SFMSplitPlates

Note

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

o Property SplitPlatesObjects() As SfmSplitPlates (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

Return type:

SFMSplitPlates

property support: Reference

Note

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

o Property Support() As Reference

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

Return type:

Reference

property support_offset: float

Note

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

o Property SupportOffset() As double

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

Return type:

float

property support_offset_param: Length

Note

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

o Property SupportOffsetParam() As Length (Read Only)

Return type:

Length

property thickness: float

Note

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

o Property Thickness() As double

Returns or sets the SuperPlate’s Thickness.

Example:

This example retrieves the Thickness of existing

SuperPlate.

Dim ThicknessValue As Double

Set ThicknessValue = SuperPlate.Thickness

Return type:

float