NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::LineDesigner::StairwayEquipmentBuilder Class Reference


To create a new instance of this class, use NXOpen::LineDesigner::LineDesignerManager::CreateStairwayEquipmentBuilder
Default values. More...

Inheritance diagram for NXOpen::LineDesigner::StairwayEquipmentBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool AddLeftRailingToggle ()
 Returns the left railing toggle
Created in NX9.0.0. More...
 
bool AddRightRailingToggle ()
 Returns the right railing toggle
Created in NX9.0.0. More...
 
bool AddRiserToggle ()
 Returns the riser toggle
Created in NX9.0.0. More...
 
bool AddStringerToggle ()
 Returns the stringer toggle
Created in NX9.0.0. More...
 
NXOpen::ExpressionEndElevation ()
 Returns the end elevation of stairway
Created in NX9.0.0. More...
 
NXOpen::KFObjectKfObject ()
 Returns the kf object is return
Created in NX9.0.0. More...
 
int NoOfStairs ()
 Returns the number of stairs
Created in NX9.0.0. More...
 
NXOpen::ExpressionRise ()
 Returns the vertical distance between two steps
Created in NX9.0.0. More...
 
NXOpen::ExpressionRun ()
 Returns the run
Created in NX9.0.0. More...
 
void SetAddLeftRailingToggle (bool addLeftRailingToggle)
 Sets the left railing toggle
Created in NX9.0.0. More...
 
void SetAddRightRailingToggle (bool addRightRailingToggle)
 Sets the right railing toggle
Created in NX9.0.0. More...
 
void SetAddRiserToggle (bool addRiserToggle)
 Sets the riser toggle
Created in NX9.0.0. More...
 
void SetAddStringerToggle (bool addStringerToggle)
 Sets the stringer toggle
Created in NX9.0.0. More...
 
void SetNoOfStairs (int noOfStairs)
 Sets the number of stairs
Created in NX9.0.0. More...
 
NXOpen::ExpressionStairNosing ()
 Returns the stair nosing
Created in NX9.0.0. More...
 
NXOpen::ExpressionStairWidth ()
 Returns the stair width
Created in NX9.0.0. More...
 
NXOpen::ExpressionStartElevation ()
 Returns the start elevation of stairway
Created in NX9.0.0. More...
 
NXOpen::ExpressionStringerHeight ()
 Returns the stringer height
Created in NX9.0.0. More...
 
NXOpen::ExpressionStringerWidth ()
 Returns the stringer width
Created in NX9.0.0. More...
 
NXOpen::ExpressionTotalRise ()
 Returns the total rise
Created in NX9.0.0. More...
 
NXOpen::ExpressionTotalRun ()
 Returns the total run
Created in NX9.0.0. More...
 
NXOpen::ExpressionTreadHeight ()
 Returns the tread height
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description


To create a new instance of this class, use NXOpen::LineDesigner::LineDesignerManager::CreateStairwayEquipmentBuilder
Default values.

Property Value

AddRiserToggle

0

AddStringerToggle

1

EndElevation.Value

2425 (millimeters part), 117 (inches part)

NoOfStairs

8

Rise.Value

175 (millimeters part), 7 (inches part)

Run.Value

280 (millimeters part), 11 (inches part)

StairNosing.Value

13 (millimeters part), 0.5 (inches part)

StairWidth.Value

915 (millimeters part), 36 (inches part)

StartElevation.Value

4000 (millimeters part), 180 (inches part)

StringerHeight.Value

305 (millimeters part), 12 (inches part)

StringerWidth.Value

37.5 (millimeters part), 1.5 (inches part)

TotalRise.Value

-1575 (millimeters part), -63 (inches part)

TotalRun.Value

2240 (millimeters part), 88 (inches part)

TreadHeight.Value

50 (millimeters part), 1.5 (inches part)


Created in NX9.0.0.

Member Function Documentation

bool NXOpen::LineDesigner::StairwayEquipmentBuilder::AddLeftRailingToggle ( )

Returns the left railing toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

bool NXOpen::LineDesigner::StairwayEquipmentBuilder::AddRightRailingToggle ( )

Returns the right railing toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

bool NXOpen::LineDesigner::StairwayEquipmentBuilder::AddRiserToggle ( )

Returns the riser toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

bool NXOpen::LineDesigner::StairwayEquipmentBuilder::AddStringerToggle ( )

Returns the stringer toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::EndElevation ( )

Returns the end elevation of stairway
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::KFObject* NXOpen::LineDesigner::StairwayEquipmentBuilder::KfObject ( )

Returns the kf object is return
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

int NXOpen::LineDesigner::StairwayEquipmentBuilder::NoOfStairs ( )

Returns the number of stairs
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::Rise ( )

Returns the vertical distance between two steps
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::Run ( )

Returns the run
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

void NXOpen::LineDesigner::StairwayEquipmentBuilder::SetAddLeftRailingToggle ( bool  addLeftRailingToggle)

Sets the left railing toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
addLeftRailingToggleaddleftrailingtoggle
void NXOpen::LineDesigner::StairwayEquipmentBuilder::SetAddRightRailingToggle ( bool  addRightRailingToggle)

Sets the right railing toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
addRightRailingToggleaddrightrailingtoggle
void NXOpen::LineDesigner::StairwayEquipmentBuilder::SetAddRiserToggle ( bool  addRiserToggle)

Sets the riser toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
addRiserToggleaddrisertoggle
void NXOpen::LineDesigner::StairwayEquipmentBuilder::SetAddStringerToggle ( bool  addStringerToggle)

Sets the stringer toggle
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
addStringerToggleaddstringertoggle
void NXOpen::LineDesigner::StairwayEquipmentBuilder::SetNoOfStairs ( int  noOfStairs)

Sets the number of stairs
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
noOfStairsnoofstairs
NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::StairNosing ( )

Returns the stair nosing
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::StairWidth ( )

Returns the stair width
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::StartElevation ( )

Returns the start elevation of stairway
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::StringerHeight ( )

Returns the stringer height
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::StringerWidth ( )

Returns the stringer width
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::TotalRise ( )

Returns the total rise
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::TotalRun ( )

Returns the total run
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::StairwayEquipmentBuilder::TreadHeight ( )

Returns the tread height
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")


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