RailOpeningFeatureBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# RailOpeningFeatureBuilder Class

class `NXOpen.LineDesigner.``RailOpeningFeatureBuilder`

  Bases: `NXOpen.Builder`

  Represents a `LineDesigner.RailOpeningFeature` builder

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

  Default values.

  Property | Value
  --- | ---
  LinearDimElevation.Value | 650 (millimeters part), 25.6 (inches part)
  LinearDimGateThickness.Value | 37.5 (millimeters part), 1.5 (inches part)
  LinearDimOpeningWidth.Value | 350 (millimeters part), 14 (inches part)
  OpeningAddGate | 0
  OpeningStyleEnum | Left

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
LinearDimElevation | Returns the rail opening elevation
LinearDimGateThickness | Returns the gate thickness
LinearDimOpeningWidth | Returns the rail opening width
OpeningAddGate | Returns or sets the opening add gate is return
OpeningStyleEnum | Returns or sets the rail opening style enum
ReverseDirection | Returns or sets the reverse direction of rail opening
SelectPoint | Returns or sets the selected point of rail opening feature
Tag | Returns the Tag for this object.

# 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.
GetDirVector | Direction of rail opening
GetObject | Returns the object currently being edited by this builder.
SetDirVector |
SetRailingFeature |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

RailOpeningFeatureBuilderGateOpeningStyle Enumeration | This enum is providing possible gate opening styles

# Property Detail

## LinearDimElevation

`RailOpeningFeatureBuilder.``LinearDimElevation`

  Returns the rail opening elevation

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

  Getter Method

  Signature `LinearDimElevation`

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

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## LinearDimGateThickness

`RailOpeningFeatureBuilder.``LinearDimGateThickness`

  Returns the gate thickness

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

  Getter Method

  Signature `LinearDimGateThickness`

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

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## LinearDimOpeningWidth

`RailOpeningFeatureBuilder.``LinearDimOpeningWidth`

  Returns the rail opening width

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

  Getter Method

  Signature `LinearDimOpeningWidth`

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

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## OpeningAddGate

`RailOpeningFeatureBuilder.``OpeningAddGate`

  Returns or sets the opening add gate is return

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

  Getter Method

  Signature `OpeningAddGate`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

  Setter Method

  Signature `OpeningAddGate`

  Parameters: | openingAddGate (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## OpeningStyleEnum

`RailOpeningFeatureBuilder.``OpeningStyleEnum`

  Returns or sets the rail opening style enum

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

  Getter Method

  Signature `OpeningStyleEnum`

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

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

  Setter Method

  Signature `OpeningStyleEnum`

  Parameters: | openingStyleEnum (`NXOpen.LineDesigner.RailOpeningFeatureBuilderGateOpeningStyle`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## ReverseDirection

`RailOpeningFeatureBuilder.``ReverseDirection`

  Returns or sets the reverse direction of rail opening

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

  Getter Method

  Signature `ReverseDirection`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

  Setter Method

  Signature `ReverseDirection`

  Parameters: | reverseDirection (bool) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## SelectPoint

`RailOpeningFeatureBuilder.``SelectPoint`

  Returns or sets the selected point of rail opening feature

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

  Getter Method

  Signature `SelectPoint`

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

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

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

  Setter Method

  Signature `SelectPoint`

  Parameters: | selectPoint (`NXOpen.Point`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

# Method Detail

## GetDirVector

`RailOpeningFeatureBuilder.``GetDirVector`

  Direction of rail opening

  Signature `GetDirVector()`

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

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## SetDirVector

`RailOpeningFeatureBuilder.``SetDirVector`

  Signature `SetDirVector(dirVector)`

  Parameters: | dirVector (`NXOpen.Direction`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## SetRailingFeature

`RailOpeningFeatureBuilder.``SetRailingFeature`

  Signature `SetRailingFeature(railingFrec)`

  Parameters: | railingFrec (`NXOpen.Features.Feature`) –

  New in version NX9.0.0.

  License requirements: ld_line_designer (“FULL LINE DESIGNER”)

## Validate

`RailOpeningFeatureBuilder.``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.