RailingFeatureBuilder Class¶
-
class
NXOpen.LineDesigner.
RailingFeatureBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
LineDesigner.RailingFeature
Features.FeatureBuilder
To create a new instance of this class, use
NXOpen.LineDesigner.LineDesignerManager.CreateRailingFeatureBuilder()
Default values.
Property Value EnumPostCrossStyle Rectangle EnumRailCrossStyle Rectangle EnumSpacingType CountandSpan IntegerCount 2 LinearDimBottomElevation.Value 0 (millimeters part), 0 (inches part) LinearDimPitchBy.Value 100 (millimeters part), 4 (inches part) LinearDimPostCrossDia.Value 37.5 (millimeters part), 1.5 (inches part) LinearDimPostCrossLength.Value 37.5 (millimeters part), 1.5 (inches part) LinearDimPostCrossTickness.Value 3.35 (millimeters part), 0.13 (inches part) LinearDimPostCrossWidth.Value 37.5 (millimeters part), 1.5 (inches part) LinearDimPostHeight.Value 1067 (millimeters part), 42 (inches part) LinearDimPostSpacing.Value 500 (millimeters part), 20 (inches part) LinearDimRailCrossDia.Value 37.5 (millimeters part), 1.5 (inches part) LinearDimRailCrossLength.Value 37.5 (millimeters part), 1.57 (inches part) LinearDimRailCrossWidth.Value 37.5 (millimeters part), 1.5 (inches part) OnPathDimSpanBy.Expression.Value 1067 (millimeters part), 42 (inches part) PostOffset PostOnCurve New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
EnumPostCrossStyle | Returns or sets the post cross style enum |
EnumRailCrossStyle | Returns or sets the railing cross style enum |
EnumSpacingType | Returns or sets an API to get spacing type enum |
IntegerCount | Returns or sets an API to get integer count |
IsSketchInternal | Returns or sets an API to check if sketch is internal |
LinearDimBottomElevation | Returns an API to get bottom elevation |
LinearDimPitchBy | Returns an API to get pitch by |
LinearDimPostCrossDia | Returns the post cross dimension of railing feature |
LinearDimPostCrossLength | Returns the post cross length of railing feature |
LinearDimPostCrossTickness | Returns the post cross thickness of railing feature |
LinearDimPostCrossWidth | Returns the post cross width of railing feature |
LinearDimPostHeight | Returns the post height of railing feature |
LinearDimPostSpacing | Returns the post spacing of railing feature |
LinearDimRailCrossDia | Returns an API to get railing cross diamension |
LinearDimRailCrossLength | Returns the railing cross length of railing feature |
LinearDimRailCrossWidth | Returns the railing cross width of railing feature |
OnPathDimSpanBy | Returns an API to get on path dimension span by |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
PostOffset | Returns or sets the post offset of railing feature |
SelectionCurves | Returns the selected curves are return |
SelectionPostCrossSection | Returns the selection post cross section |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
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. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
RailingFeatureBuilderPostOffsetType Enumeration | This enum is providing possible post offset types |
RailingFeatureBuilderRailCrossStyle Enumeration | This enum is providing possible railing cross styles |
RailingFeatureBuilderSelPostcrossStyle Enumeration | This enum is providing possible selection post cross styles |
RailingFeatureBuilderSpaceType Enumeration | This enum is providing possible space types |
Property Detail¶
EnumPostCrossStyle¶
-
RailingFeatureBuilder.
EnumPostCrossStyle
¶ Returns or sets the post cross style enum
-------------------------------------
Getter Method
Signature
EnumPostCrossStyle
Returns: Return type: NXOpen.LineDesigner.RailingFeatureBuilderSelPostcrossStyle
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
EnumPostCrossStyle
Parameters: enumPostCrossStyle ( NXOpen.LineDesigner.RailingFeatureBuilderSelPostcrossStyle
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
EnumRailCrossStyle¶
-
RailingFeatureBuilder.
EnumRailCrossStyle
¶ Returns or sets the railing cross style enum
-------------------------------------
Getter Method
Signature
EnumRailCrossStyle
Returns: Return type: NXOpen.LineDesigner.RailingFeatureBuilderRailCrossStyle
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
EnumRailCrossStyle
Parameters: enumRailCrossStyle ( NXOpen.LineDesigner.RailingFeatureBuilderRailCrossStyle
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
EnumSpacingType¶
-
RailingFeatureBuilder.
EnumSpacingType
¶ Returns or sets an API to get spacing type enum
-------------------------------------
Getter Method
Signature
EnumSpacingType
Returns: Return type: NXOpen.LineDesigner.RailingFeatureBuilderSpaceType
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
EnumSpacingType
Parameters: enumSpacingType ( NXOpen.LineDesigner.RailingFeatureBuilderSpaceType
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
IntegerCount¶
-
RailingFeatureBuilder.
IntegerCount
¶ Returns or sets an API to get integer count
-------------------------------------
Getter Method
Signature
IntegerCount
Returns: Return type: int New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
IntegerCount
Parameters: integerCount (int) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
IsSketchInternal¶
-
RailingFeatureBuilder.
IsSketchInternal
¶ Returns or sets an API to check if sketch is internal
-------------------------------------
Getter Method
Signature
IsSketchInternal
Returns: Return type: bool New in version NX10.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
IsSketchInternal
Parameters: makeSketchInternal (bool) – New in version NX10.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimBottomElevation¶
-
RailingFeatureBuilder.
LinearDimBottomElevation
¶ Returns an API to get bottom elevation
-------------------------------------
Getter Method
Signature
LinearDimBottomElevation
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPitchBy¶
-
RailingFeatureBuilder.
LinearDimPitchBy
¶ Returns an API to get pitch by
-------------------------------------
Getter Method
Signature
LinearDimPitchBy
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPostCrossDia¶
-
RailingFeatureBuilder.
LinearDimPostCrossDia
¶ Returns the post cross dimension of railing feature
-------------------------------------
Getter Method
Signature
LinearDimPostCrossDia
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPostCrossLength¶
-
RailingFeatureBuilder.
LinearDimPostCrossLength
¶ Returns the post cross length of railing feature
-------------------------------------
Getter Method
Signature
LinearDimPostCrossLength
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPostCrossTickness¶
-
RailingFeatureBuilder.
LinearDimPostCrossTickness
¶ Returns the post cross thickness of railing feature
-------------------------------------
Getter Method
Signature
LinearDimPostCrossTickness
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPostCrossWidth¶
-
RailingFeatureBuilder.
LinearDimPostCrossWidth
¶ Returns the post cross width of railing feature
-------------------------------------
Getter Method
Signature
LinearDimPostCrossWidth
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPostHeight¶
-
RailingFeatureBuilder.
LinearDimPostHeight
¶ Returns the post height of railing feature
-------------------------------------
Getter Method
Signature
LinearDimPostHeight
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimPostSpacing¶
-
RailingFeatureBuilder.
LinearDimPostSpacing
¶ Returns the post spacing of railing feature
-------------------------------------
Getter Method
Signature
LinearDimPostSpacing
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimRailCrossDia¶
-
RailingFeatureBuilder.
LinearDimRailCrossDia
¶ Returns an API to get railing cross diamension
-------------------------------------
Getter Method
Signature
LinearDimRailCrossDia
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimRailCrossLength¶
-
RailingFeatureBuilder.
LinearDimRailCrossLength
¶ Returns the railing cross length of railing feature
-------------------------------------
Getter Method
Signature
LinearDimRailCrossLength
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
LinearDimRailCrossWidth¶
-
RailingFeatureBuilder.
LinearDimRailCrossWidth
¶ Returns the railing cross width of railing feature
-------------------------------------
Getter Method
Signature
LinearDimRailCrossWidth
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
OnPathDimSpanBy¶
-
RailingFeatureBuilder.
OnPathDimSpanBy
¶ Returns an API to get on path dimension span by
-------------------------------------
Getter Method
Signature
OnPathDimSpanBy
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
PostOffset¶
-
RailingFeatureBuilder.
PostOffset
¶ Returns or sets the post offset of railing feature
-------------------------------------
Getter Method
Signature
PostOffset
Returns: Return type: NXOpen.LineDesigner.RailingFeatureBuilderPostOffsetType
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
PostOffset
Parameters: postOffset ( NXOpen.LineDesigner.RailingFeatureBuilderPostOffsetType
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SelectionCurves¶
-
RailingFeatureBuilder.
SelectionCurves
¶ Returns the selected curves are return
-------------------------------------
Getter Method
Signature
SelectionCurves
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SelectionPostCrossSection¶
-
RailingFeatureBuilder.
SelectionPostCrossSection
¶ Returns the selection post cross section
-------------------------------------
Getter Method
Signature
SelectionPostCrossSection
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Method Detail¶
Validate¶
-
RailingFeatureBuilder.
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.