HandrailBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# HandrailBuilder Class

class `NXOpen.Routing.``HandrailBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Routing.HandrailBuilder` Creates a handrail from a selected point.

  The handrail is created by optionally placing a post depending on the post type followed by placing the rails across the route control points corresponding to the posts.

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateHandrailBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AutoCloseOption | Returns or sets an option to automatically close the handrail
HasHorizontalRails | Returns or sets an option to create horizontal rail stock
PostType | Returns or sets the type of post: Start, Intermediate, None, End
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.
GetObject | Returns the object currently being edited by this builder.
PlaceHandrail | Creates a handrail post, horizontal railings assembly components and places them in the appropriate orientation.
ReverseLastPost | Reverses the orientation of the last placed post
SetHandrailPartCharx | Sets the handrail part characteristics
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

HandrailBuilderPostTypes Enumeration | The post type: Start, Intermediate, None, End.

# Property Detail

## AutoCloseOption

`HandrailBuilder.``AutoCloseOption`

  Returns or sets an option to automatically close the handrail

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

  Getter Method

  Signature `AutoCloseOption`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

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

  Setter Method

  Signature `AutoCloseOption`

  Parameters: | autoClose (bool) –

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

## HasHorizontalRails

`HandrailBuilder.``HasHorizontalRails`

  Returns or sets an option to create horizontal rail stock

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

  Getter Method

  Signature `HasHorizontalRails`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

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

  Setter Method

  Signature `HasHorizontalRails`

  Parameters: | railOption (bool) –

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

## PostType

`HandrailBuilder.``PostType`

  Returns or sets the type of post: Start, Intermediate, None, End

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

  Getter Method

  Signature `PostType`

  Returns: |
  Return type: | `NXOpen.Routing.HandrailBuilderPostTypes`

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

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

  Setter Method

  Signature `PostType`

  Parameters: | postType (`NXOpen.Routing.HandrailBuilderPostTypes`) –

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

# Method Detail

## PlaceHandrail

`HandrailBuilder.``PlaceHandrail`

  Creates a handrail post, horizontal railings assembly components and places them in the appropriate orientation.

  Signature `PlaceHandrail(postLocation)`

  Parameters: | postLocation (`NXOpen.Point3d`) – The point where the handrail is to be placed

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

## ReverseLastPost

`HandrailBuilder.``ReverseLastPost`

  Reverses the orientation of the last placed post

  Signature `ReverseLastPost()`

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

## SetHandrailPartCharx

`HandrailBuilder.``SetHandrailPartCharx`

  Sets the handrail part characteristics

  Signature `SetHandrailPartCharx(partCharx)`

  Parameters: | partCharx (`NXOpen.Routing.CharacteristicList`) – The characteristics to use for the handrail posts

  New in version NX8.5.0.

  License requirements: routing_platform (“Routing Platform”)

## Validate

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