StairwayEquipmentBuilder Class¶
-
class
NXOpen.LineDesigner.
StairwayEquipmentBuilder
¶ Bases:
NXOpen.Builder
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) New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AddLeftRailingToggle | Returns or sets the add left railing toggle |
AddRightRailingToggle | Returns or sets the add right railing toggle |
AddRiserToggle | Returns or sets the add riser toggle |
AddStringerToggle | Returns or sets the add stringer toggle |
EndElevation | Returns the end elevation |
KfObject | Returns the kf object |
NoOfStairs | Returns or sets the no of stairs |
Rise | Returns the rise |
Run | Returns the run |
StairNosing | Returns the stair nosing |
StairWidth | Returns the stair width |
StartElevation | Returns the start elevation |
StringerHeight | Returns the stringer height |
StringerWidth | Returns the stringer width |
Tag | Returns the Tag for this object. |
TotalRise | Returns the total rise |
TotalRun | Returns the total run |
TreadHeight | Returns the tread height |
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. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AddLeftRailingToggle¶
-
StairwayEquipmentBuilder.
AddLeftRailingToggle
¶ Returns or sets the add left railing toggle
-------------------------------------
Getter Method
Signature
AddLeftRailingToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
AddLeftRailingToggle(addLeftRailingToggle)
Parameters: addLeftRailingToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
AddRightRailingToggle¶
-
StairwayEquipmentBuilder.
AddRightRailingToggle
¶ Returns or sets the add right railing toggle
-------------------------------------
Getter Method
Signature
AddRightRailingToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
AddRightRailingToggle(addRightRailingToggle)
Parameters: addRightRailingToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
AddRiserToggle¶
-
StairwayEquipmentBuilder.
AddRiserToggle
¶ Returns or sets the add riser toggle
-------------------------------------
Getter Method
Signature
AddRiserToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
AddRiserToggle(addRiserToggle)
Parameters: addRiserToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
AddStringerToggle¶
-
StairwayEquipmentBuilder.
AddStringerToggle
¶ Returns or sets the add stringer toggle
-------------------------------------
Getter Method
Signature
AddStringerToggle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
AddStringerToggle(addStringerToggle)
Parameters: addStringerToggle (bool) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
EndElevation¶
-
StairwayEquipmentBuilder.
EndElevation
¶ Returns the end elevation
-------------------------------------
Getter Method
Signature
EndElevation()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
KfObject¶
-
StairwayEquipmentBuilder.
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”)
NoOfStairs¶
-
StairwayEquipmentBuilder.
NoOfStairs
¶ Returns or sets the no of stairs
-------------------------------------
Getter Method
Signature
NoOfStairs()
Returns: Return type: int New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
NoOfStairs(noOfStairs)
Parameters: noOfStairs (int) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Rise¶
-
StairwayEquipmentBuilder.
Rise
¶ Returns the rise
-------------------------------------
Getter Method
Signature
Rise()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Run¶
-
StairwayEquipmentBuilder.
Run
¶ Returns the run
-------------------------------------
Getter Method
Signature
Run()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
StairNosing¶
-
StairwayEquipmentBuilder.
StairNosing
¶ Returns the stair nosing
-------------------------------------
Getter Method
Signature
StairNosing()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
StairWidth¶
-
StairwayEquipmentBuilder.
StairWidth
¶ Returns the stair width
-------------------------------------
Getter Method
Signature
StairWidth()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
StartElevation¶
-
StairwayEquipmentBuilder.
StartElevation
¶ Returns the start elevation
-------------------------------------
Getter Method
Signature
StartElevation()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
StringerHeight¶
-
StairwayEquipmentBuilder.
StringerHeight
¶ Returns the stringer height
-------------------------------------
Getter Method
Signature
StringerHeight()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
StringerWidth¶
-
StairwayEquipmentBuilder.
StringerWidth
¶ Returns the stringer width
-------------------------------------
Getter Method
Signature
StringerWidth()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
TotalRise¶
-
StairwayEquipmentBuilder.
TotalRise
¶ Returns the total rise
-------------------------------------
Getter Method
Signature
TotalRise()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
TotalRun¶
-
StairwayEquipmentBuilder.
TotalRun
¶ Returns the total run
-------------------------------------
Getter Method
Signature
TotalRun()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
TreadHeight¶
-
StairwayEquipmentBuilder.
TreadHeight
¶ Returns the tread height
-------------------------------------
Getter Method
Signature
TreadHeight()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Method Detail¶
Validate¶
-
StairwayEquipmentBuilder.
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.