NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Routing.HandrailBuilder Class Reference

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

Inheritance diagram for NXOpen.Routing.HandrailBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  PostTypes { Start, Intermediate, None, End }
 The post type: Start, Intermediate, None, End. More...
 

Public Member Functions

unsafe void PlaceHandrail (NXOpen.Point3d postLocation)
 Creates a handrail post, horizontal railings assembly components and places them in the appropriate orientation. More...
 
unsafe void ReverseLastPost ()
 Reverses the orientation of the last placed post More...
 
unsafe void SetHandrailPartCharx (NXOpen.Routing.CharacteristicList partCharx)
 Sets the handrail part characteristics More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool AutoCloseOption [get, set]
 Returns or sets an option to automatically close the handrail More...
 
unsafe bool HasHorizontalRails [get, set]
 Returns or sets an option to create horizontal rail stock More...
 
unsafe
NXOpen.Routing.HandrailBuilder.PostTypes 
PostType [get, set]
 Returns or sets the type of post: Start, Intermediate, None, End More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

Created in NX8.5.0

Member Enumeration Documentation

The post type: Start, Intermediate, None, End.

Start implies closing rails must be closed to the start post. Intermediate implies that the post is neither a start nor an end post but in the middle. None implies the post is intermediate with rails but without a post. End implies the post is the last of the posts.

Enumerator
Start 
Intermediate 
None 
End 

Member Function Documentation

unsafe void NXOpen.Routing.HandrailBuilder.PlaceHandrail ( NXOpen.Point3d  postLocation)
inline

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

Created in NX8.5.0

License requirements: routing_platform ("Routing Platform")

Parameters
postLocationThe point where the handrail is to be placed
unsafe void NXOpen.Routing.HandrailBuilder.ReverseLastPost ( )
inline

Reverses the orientation of the last placed post

Created in NX8.5.0

License requirements: routing_platform ("Routing Platform")

unsafe void NXOpen.Routing.HandrailBuilder.SetHandrailPartCharx ( NXOpen.Routing.CharacteristicList  partCharx)
inline

Sets the handrail part characteristics

Created in NX8.5.0

License requirements: routing_platform ("Routing Platform")

Parameters
partCharxThe characteristics to use for the handrail posts

Property Documentation

unsafe bool NXOpen.Routing.HandrailBuilder.AutoCloseOption
getset

Returns or sets an option to automatically close the handrail

Created in NX8.5.0

License requirements to get this property: routing_platform ("Routing Platform")

License requirements to set this property: routing_platform ("Routing Platform")

unsafe bool NXOpen.Routing.HandrailBuilder.HasHorizontalRails
getset

Returns or sets an option to create horizontal rail stock

Created in NX8.5.0

License requirements to get this property: routing_platform ("Routing Platform")

License requirements to set this property: routing_platform ("Routing Platform")

unsafe NXOpen.Routing.HandrailBuilder.PostTypes NXOpen.Routing.HandrailBuilder.PostType
getset

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

Created in NX8.5.0

License requirements to get this property: routing_platform ("Routing Platform")

License requirements to set this property: routing_platform ("Routing Platform")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.