PlatformEquipmentBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PlatformEquipmentBuilder Class

class `NXOpen.LineDesigner.``PlatformEquipmentBuilder`

  Bases: `NXOpen.Builder`

  To create a new instance of this class, use `NXOpen.LineDesigner.LineDesignerManager.CreatePlatformEquipmentBuilder()`

  Default values.

  Property | Value
  --- | ---
  AddRailingToggle | 1
  DeckCeilingHeightForCenterline.Value | 9000 (millimeters part), 354.5 (inches part)
  DeckCeilingHeightForPolyline.Value | 9000 (millimeters part), 354.5 (inches part)
  DeckElevationForCenterline.Value | 0 (millimeters part), 0 (inches part)
  DeckElevationForPolyline.Value | 0 (millimeters part), 0 (inches part)
  DeckHeightForCenterline.Value | 525 (millimeters part), 21 (inches part)
  DeckHeightForPolyline.Value | 1750 (millimeters part), 68.9 (inches part)
  DeckLengthForCenterline.Value | 2540 (millimeters part), 100 (inches part)
  DeckSupportEnum | NoSupports
  DeckThicknessForCenterline.Value | 300 (millimeters part), 12 (inches part)
  DeckThicknessForPolyline.Value | 300 (millimeters part), 12 (inches part)
  DeckWidthForCenterline.Value | 2438 (millimeters part), 96 (inches part)
  DeckingMaterial | MetalGrate
  DistanceFromCenterline.Value | 660 (millimeters part), 26 (inches part)
  HorizontalGridSpacing.Value | 4000 (millimeters part), 157.5 (inches part)
  OutlineEnum | Polyline
  SideFromCenterlineEnum | RightTopSide
  SupportsFromCeiling | 0
  TypeEnum | Platform
  VerticalGridSpacing.Value | 3200 (millimeters part), 126 (inches part)

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AddRailingToggle | Returns or sets the railing toggle to check railing is prsent for platform or not
CenterlineJigOnPlane | Returns or sets the Centerlinejig on plane builder
DeckCeilingHeightForCenterline | Returns the deck ceiling height for centerline platform
DeckCeilingHeightForPolyline | Returns the deck ceiling height for polyline platform
DeckElevationForCenterline | Returns the deck elevation for centerline platform
DeckElevationForPolyline | Returns the deck elevation for polyline platform
DeckHeightForCenterline | Returns the deck height for centerline platform
DeckHeightForPolyline | Returns the deck height for polyline platform
DeckLengthForCenterline | Returns the deck length for centerline platform
DeckSupportEnum | Returns or sets the deck support type for platform
DeckThicknessForCenterline | Returns the deck thickness for centerline platform
DeckThicknessForPolyline | Returns the deck thickness for polyline platform
DeckWidthForCenterline | Returns the deck width for centerline platform
DeckingMaterial | Returns or sets the decking material
DistanceFromCenterline | Returns the distance of platform from centerline
HorizontalGridSpacing | Returns the horizontal grid spacing
IsSketchInternal | Returns or sets the issketchiInternal
KfObject | Returns the kf object
OutlineEnum | Returns or sets the outline type enum
PolylineSuperSection | Returns the polyline section for platform
SideFromCenterlineEnum | Returns or sets the side from center line
StatusOfPlatformCeilingHeightUpdation | Returns or sets the platform ceiling height updation status
StatusOfPlatformElevationUpdation | Returns or sets the platform elevation updation status
StatusOfPlatformHeightUpdation | Returns or sets the platform height updation status
StatusOfPlatformSupportDefaultFromCeilingToggleUpdation | Returns or sets the platform supportDefaultFromCeilingToggle updation status
StatusOfPlatformSupportOptionUpdation | Returns or sets the platform supportOption updation status
StatusOfPlatformThicknessUpdation | Returns or sets the platform thickness updation status
SupportsFromCeiling | Returns or sets the option to check , if supports are from ceiling
Tag | Returns the Tag for this object.
TypeEnum | Returns or sets the platform type enum
VerticalGridSpacing | Returns the vertical grid spacing

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
SupportCrossSectionButton |
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

PlatformEquipmentBuilderDeckSupportTypeAPI Enumeration | This enum is providing possible deck support types
PlatformEquipmentBuilderDeckingMaterialTypeAPI Enumeration | This enum is providing possible deck material type
PlatformEquipmentBuilderOutlineTypeAPI Enumeration | This enum is providing possible outline types
PlatformEquipmentBuilderSideFromCenterlineTypeAPI Enumeration | This enum is providing possible sides for centerline outline type
PlatformEquipmentBuilderTypeAPI Enumeration | This enum is providing possible platform types

# Property Detail

## AddRailingToggle

`PlatformEquipmentBuilder.``AddRailingToggle`

  Returns or sets the railing toggle to check railing is prsent for platform or not

  `-------------------------------------`

  Getter Method

  Signature `AddRailingToggle`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `AddRailingToggle`

  Parameters: | addRailingToggle (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## CenterlineJigOnPlane

`PlatformEquipmentBuilder.``CenterlineJigOnPlane`

  Returns or sets the Centerlinejig on plane builder

  `-------------------------------------`

  Getter Method

  Signature `CenterlineJigOnPlane`

  Returns: |
  Return type: | `NXOpen.LineDesigner.JigOnPlaneBuilder`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `CenterlineJigOnPlane`

  Parameters: | centerlineJigOnPlane (`NXOpen.LineDesigner.JigOnPlaneBuilder`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckCeilingHeightForCenterline

`PlatformEquipmentBuilder.``DeckCeilingHeightForCenterline`

  Returns the deck ceiling height for centerline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckCeilingHeightForCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckCeilingHeightForPolyline

`PlatformEquipmentBuilder.``DeckCeilingHeightForPolyline`

  Returns the deck ceiling height for polyline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckCeilingHeightForPolyline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckElevationForCenterline

`PlatformEquipmentBuilder.``DeckElevationForCenterline`

  Returns the deck elevation for centerline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckElevationForCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckElevationForPolyline

`PlatformEquipmentBuilder.``DeckElevationForPolyline`

  Returns the deck elevation for polyline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckElevationForPolyline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckHeightForCenterline

`PlatformEquipmentBuilder.``DeckHeightForCenterline`

  Returns the deck height for centerline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckHeightForCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckHeightForPolyline

`PlatformEquipmentBuilder.``DeckHeightForPolyline`

  Returns the deck height for polyline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckHeightForPolyline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckLengthForCenterline

`PlatformEquipmentBuilder.``DeckLengthForCenterline`

  Returns the deck length for centerline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckLengthForCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckSupportEnum

`PlatformEquipmentBuilder.``DeckSupportEnum`

  Returns or sets the deck support type for platform

  `-------------------------------------`

  Getter Method

  Signature `DeckSupportEnum`

  Returns: |
  Return type: | `NXOpen.LineDesigner.PlatformEquipmentBuilderDeckSupportTypeAPI`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `DeckSupportEnum`

  Parameters: | deckSupportEnum (`NXOpen.LineDesigner.PlatformEquipmentBuilderDeckSupportTypeAPI`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckThicknessForCenterline

`PlatformEquipmentBuilder.``DeckThicknessForCenterline`

  Returns the deck thickness for centerline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckThicknessForCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckThicknessForPolyline

`PlatformEquipmentBuilder.``DeckThicknessForPolyline`

  Returns the deck thickness for polyline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckThicknessForPolyline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckWidthForCenterline

`PlatformEquipmentBuilder.``DeckWidthForCenterline`

  Returns the deck width for centerline platform

  `-------------------------------------`

  Getter Method

  Signature `DeckWidthForCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DeckingMaterial

`PlatformEquipmentBuilder.``DeckingMaterial`

  Returns or sets the decking material

  `-------------------------------------`

  Getter Method

  Signature `DeckingMaterial`

  Returns: |
  Return type: | `NXOpen.LineDesigner.PlatformEquipmentBuilderDeckingMaterialTypeAPI`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `DeckingMaterial`

  Parameters: | deckingMaterial (`NXOpen.LineDesigner.PlatformEquipmentBuilderDeckingMaterialTypeAPI`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## DistanceFromCenterline

`PlatformEquipmentBuilder.``DistanceFromCenterline`

  Returns the distance of platform from centerline

  `-------------------------------------`

  Getter Method

  Signature `DistanceFromCenterline`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## HorizontalGridSpacing

`PlatformEquipmentBuilder.``HorizontalGridSpacing`

  Returns the horizontal grid spacing

  `-------------------------------------`

  Getter Method

  Signature `HorizontalGridSpacing`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## IsSketchInternal

`PlatformEquipmentBuilder.``IsSketchInternal`

  Returns or sets the issketchiInternal

  `-------------------------------------`

  Getter Method

  Signature `IsSketchInternal`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `IsSketchInternal`

  Parameters: | makeSketchInternal (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## KfObject

`PlatformEquipmentBuilder.``KfObject`

  Returns the kf object

  `-------------------------------------`

  Getter Method

  Signature `KfObject`

  Returns: |
  Return type: | `NXOpen.KFObject`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## OutlineEnum

`PlatformEquipmentBuilder.``OutlineEnum`

  Returns or sets the outline type enum

  `-------------------------------------`

  Getter Method

  Signature `OutlineEnum`

  Returns: |
  Return type: | `NXOpen.LineDesigner.PlatformEquipmentBuilderOutlineTypeAPI`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `OutlineEnum`

  Parameters: | outlineEnum (`NXOpen.LineDesigner.PlatformEquipmentBuilderOutlineTypeAPI`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## PolylineSuperSection

`PlatformEquipmentBuilder.``PolylineSuperSection`

  Returns the polyline section for platform

  `-------------------------------------`

  Getter Method

  Signature `PolylineSuperSection`

  Returns: |
  Return type: | `NXOpen.Section`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## SideFromCenterlineEnum

`PlatformEquipmentBuilder.``SideFromCenterlineEnum`

  Returns or sets the side from center line

  `-------------------------------------`

  Getter Method

  Signature `SideFromCenterlineEnum`

  Returns: |
  Return type: | `NXOpen.LineDesigner.PlatformEquipmentBuilderSideFromCenterlineTypeAPI`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `SideFromCenterlineEnum`

  Parameters: | sideFromCenterlineEnum (`NXOpen.LineDesigner.PlatformEquipmentBuilderSideFromCenterlineTypeAPI`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## StatusOfPlatformCeilingHeightUpdation

`PlatformEquipmentBuilder.``StatusOfPlatformCeilingHeightUpdation`

  Returns or sets the platform ceiling height updation status

  `-------------------------------------`

  Getter Method

  Signature `StatusOfPlatformCeilingHeightUpdation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `StatusOfPlatformCeilingHeightUpdation`

  Parameters: | statusOfPlatformCeilingHeightUpdation (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## StatusOfPlatformElevationUpdation

`PlatformEquipmentBuilder.``StatusOfPlatformElevationUpdation`

  Returns or sets the platform elevation updation status

  `-------------------------------------`

  Getter Method

  Signature `StatusOfPlatformElevationUpdation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `StatusOfPlatformElevationUpdation`

  Parameters: | statusOfPlatformElevationUpdation (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## StatusOfPlatformHeightUpdation

`PlatformEquipmentBuilder.``StatusOfPlatformHeightUpdation`

  Returns or sets the platform height updation status

  `-------------------------------------`

  Getter Method

  Signature `StatusOfPlatformHeightUpdation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `StatusOfPlatformHeightUpdation`

  Parameters: | statusOfPlatformHeightUpdation (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## StatusOfPlatformSupportDefaultFromCeilingToggleUpdation

`PlatformEquipmentBuilder.``StatusOfPlatformSupportDefaultFromCeilingToggleUpdation`

  Returns or sets the platform supportDefaultFromCeilingToggle updation status

  `-------------------------------------`

  Getter Method

  Signature `StatusOfPlatformSupportDefaultFromCeilingToggleUpdation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `StatusOfPlatformSupportDefaultFromCeilingToggleUpdation`

  Parameters: | statusOfPlatformSupportDefaultFromCeilingToggleUpdation (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## StatusOfPlatformSupportOptionUpdation

`PlatformEquipmentBuilder.``StatusOfPlatformSupportOptionUpdation`

  Returns or sets the platform supportOption updation status

  `-------------------------------------`

  Getter Method

  Signature `StatusOfPlatformSupportOptionUpdation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `StatusOfPlatformSupportOptionUpdation`

  Parameters: | statusOfPlatformSupportOptionUpdation (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## StatusOfPlatformThicknessUpdation

`PlatformEquipmentBuilder.``StatusOfPlatformThicknessUpdation`

  Returns or sets the platform thickness updation status

  `-------------------------------------`

  Getter Method

  Signature `StatusOfPlatformThicknessUpdation`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `StatusOfPlatformThicknessUpdation`

  Parameters: | statusOfPlatformThicknessUpdation (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## SupportsFromCeiling

`PlatformEquipmentBuilder.``SupportsFromCeiling`

  Returns or sets the option to check , if supports are from ceiling

  `-------------------------------------`

  Getter Method

  Signature `SupportsFromCeiling`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `SupportsFromCeiling`

  Parameters: | supportsFromCeiling (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## TypeEnum

`PlatformEquipmentBuilder.``TypeEnum`

  Returns or sets the platform type enum

  `-------------------------------------`

  Getter Method

  Signature `TypeEnum`

  Returns: |
  Return type: | `NXOpen.LineDesigner.PlatformEquipmentBuilderTypeAPI`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

  `-------------------------------------`

  Setter Method

  Signature `TypeEnum`

  Parameters: | typeEnum (`NXOpen.LineDesigner.PlatformEquipmentBuilderTypeAPI`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## VerticalGridSpacing

`PlatformEquipmentBuilder.``VerticalGridSpacing`

  Returns the vertical grid spacing

  `-------------------------------------`

  Getter Method

  Signature `VerticalGridSpacing`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

# Method Detail

## SupportCrossSectionButton

`PlatformEquipmentBuilder.``SupportCrossSectionButton`

  Signature `SupportCrossSectionButton()`

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## Validate

`PlatformEquipmentBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.