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

Represents a LineDesigner::RailingFeature Features.FeatureBuilder
To create a new instance of this class, use NXOpen::LineDesigner::LineDesignerManager::CreateRailingFeatureBuilder
Default values. More...

Inheritance diagram for NXOpen::LineDesigner::RailingFeatureBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PostOffsetType { PostOffsetTypePostOnCurve, PostOffsetTypePostLeftOfCurve, PostOffsetTypePostRightOfCurve }
 This enum is providing possible post offset types. More...
 
enum  RailCrossStyle { RailCrossStyleRectangle, RailCrossStyleCircle }
 This enum is providing possible railing cross styles. More...
 
enum  SelPostcrossStyle { SelPostcrossStyleIBeam, SelPostcrossStyleRectangle, SelPostcrossStyleCircle, SelPostcrossStyleUserDefine }
 This enum is providing possible selection post cross styles. More...
 
enum  SpaceType { SpaceTypeCountandSpan, SpaceTypePitchandSpan, SpaceTypeCountandPitch }
 This enum is providing possible space types. More...
 

Public Member Functions

NXOpen::LineDesigner::RailingFeatureBuilder::SelPostcrossStyle EnumPostCrossStyle ()
 Returns the post cross style enum
Created in NX9.0.0. More...
 
NXOpen::LineDesigner::RailingFeatureBuilder::RailCrossStyle EnumRailCrossStyle ()
 Returns the railing cross style enum
Created in NX9.0.0. More...
 
NXOpen::LineDesigner::RailingFeatureBuilder::SpaceType EnumSpacingType ()
 Returns an API to get spacing type enum
Created in NX9.0.0. More...
 
int IntegerCount ()
 Returns an API to get integer count
Created in NX9.0.0. More...
 
bool IsSketchInternal ()
 Returns an API to check if sketch is internal
Created in NX10.0.0. More...
 
NXOpen::ExpressionLinearDimBottomElevation ()
 Returns an API to get bottom elevation
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPitchBy ()
 Returns an API to get pitch by
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPostCrossDia ()
 Returns the post cross dimension of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPostCrossLength ()
 Returns the post cross length of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPostCrossTickness ()
 Returns the post cross thickness of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPostCrossWidth ()
 Returns the post cross width of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPostHeight ()
 Returns the post height of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimPostSpacing ()
 Returns the post spacing of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimRailCrossDia ()
 Returns an API to get railing cross diamension
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimRailCrossLength ()
 Returns the railing cross length of railing feature
Created in NX9.0.0. More...
 
NXOpen::ExpressionLinearDimRailCrossWidth ()
 Returns the railing cross width of railing feature
Created in NX9.0.0. More...
 
NXOpen::GeometricUtilities::OnPathDimensionBuilderOnPathDimSpanBy ()
 Returns an API to get on path dimension span by
Created in NX9.0.0. More...
 
NXOpen::LineDesigner::RailingFeatureBuilder::PostOffsetType PostOffset ()
 Returns the post offset of railing feature
Created in NX9.0.0. More...
 
NXOpen::SectionSelectionCurves ()
 Returns the selected curves are return
Created in NX9.0.0. More...
 
NXOpen::SectionSelectionPostCrossSection ()
 Returns the selection post cross section
Created in NX9.0.0. More...
 
void SetEnumPostCrossStyle (NXOpen::LineDesigner::RailingFeatureBuilder::SelPostcrossStyle enumPostCrossStyle)
 Sets the post cross style enum
Created in NX9.0.0. More...
 
void SetEnumRailCrossStyle (NXOpen::LineDesigner::RailingFeatureBuilder::RailCrossStyle enumRailCrossStyle)
 Sets the railing cross style enum
Created in NX9.0.0. More...
 
void SetEnumSpacingType (NXOpen::LineDesigner::RailingFeatureBuilder::SpaceType enumSpacingType)
 Sets an API to get spacing type enum
Created in NX9.0.0. More...
 
void SetIntegerCount (int integerCount)
 Sets an API to get integer count
Created in NX9.0.0. More...
 
void SetPostOffset (NXOpen::LineDesigner::RailingFeatureBuilder::PostOffsetType postOffset)
 Sets the post offset of railing feature
Created in NX9.0.0. More...
 
void SetSketchInternal (bool makeSketchInternal)
 Sets an API to check if sketch is internal
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.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

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


Created in NX9.0.0.

Member Enumeration Documentation

This enum is providing possible post offset types.

Enumerator
PostOffsetTypePostOnCurve 

post on curve

PostOffsetTypePostLeftOfCurve 

post left of curve

PostOffsetTypePostRightOfCurve 

post right of curve

This enum is providing possible railing cross styles.

Enumerator
RailCrossStyleRectangle 

rectangle

RailCrossStyleCircle 

circle

This enum is providing possible selection post cross styles.

Enumerator
SelPostcrossStyleIBeam 

ibeam

SelPostcrossStyleRectangle 

rectangle

SelPostcrossStyleCircle 

circle

SelPostcrossStyleUserDefine 

user define

This enum is providing possible space types.

Enumerator
SpaceTypeCountandSpan 

countand span

SpaceTypePitchandSpan 

pitchand span

SpaceTypeCountandPitch 

countand pitch

Member Function Documentation

NXOpen::LineDesigner::RailingFeatureBuilder::SelPostcrossStyle NXOpen::LineDesigner::RailingFeatureBuilder::EnumPostCrossStyle ( )

Returns the post cross style enum
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::LineDesigner::RailingFeatureBuilder::RailCrossStyle NXOpen::LineDesigner::RailingFeatureBuilder::EnumRailCrossStyle ( )

Returns the railing cross style enum
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::LineDesigner::RailingFeatureBuilder::SpaceType NXOpen::LineDesigner::RailingFeatureBuilder::EnumSpacingType ( )

Returns an API to get spacing type enum
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

int NXOpen::LineDesigner::RailingFeatureBuilder::IntegerCount ( )

Returns an API to get integer count
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

bool NXOpen::LineDesigner::RailingFeatureBuilder::IsSketchInternal ( )

Returns an API to check if sketch is internal
Created in NX10.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimBottomElevation ( )

Returns an API to get bottom elevation
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPitchBy ( )

Returns an API to get pitch by
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPostCrossDia ( )

Returns the post cross dimension of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPostCrossLength ( )

Returns the post cross length of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPostCrossTickness ( )

Returns the post cross thickness of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPostCrossWidth ( )

Returns the post cross width of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPostHeight ( )

Returns the post height of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimPostSpacing ( )

Returns the post spacing of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimRailCrossDia ( )

Returns an API to get railing cross diamension
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimRailCrossLength ( )

Returns the railing cross length of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Expression* NXOpen::LineDesigner::RailingFeatureBuilder::LinearDimRailCrossWidth ( )

Returns the railing cross width of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::LineDesigner::RailingFeatureBuilder::OnPathDimSpanBy ( )

Returns an API to get on path dimension span by
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::LineDesigner::RailingFeatureBuilder::PostOffsetType NXOpen::LineDesigner::RailingFeatureBuilder::PostOffset ( )

Returns the post offset of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Section* NXOpen::LineDesigner::RailingFeatureBuilder::SelectionCurves ( )

Returns the selected curves are return
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

NXOpen::Section* NXOpen::LineDesigner::RailingFeatureBuilder::SelectionPostCrossSection ( )

Returns the selection post cross section
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

void NXOpen::LineDesigner::RailingFeatureBuilder::SetEnumPostCrossStyle ( NXOpen::LineDesigner::RailingFeatureBuilder::SelPostcrossStyle  enumPostCrossStyle)

Sets the post cross style enum
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
enumPostCrossStyleenumpostcrossstyle
void NXOpen::LineDesigner::RailingFeatureBuilder::SetEnumRailCrossStyle ( NXOpen::LineDesigner::RailingFeatureBuilder::RailCrossStyle  enumRailCrossStyle)

Sets the railing cross style enum
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
enumRailCrossStyleenumrailcrossstyle
void NXOpen::LineDesigner::RailingFeatureBuilder::SetEnumSpacingType ( NXOpen::LineDesigner::RailingFeatureBuilder::SpaceType  enumSpacingType)

Sets an API to get spacing type enum
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
enumSpacingTypeenumspacingtype
void NXOpen::LineDesigner::RailingFeatureBuilder::SetIntegerCount ( int  integerCount)

Sets an API to get integer count
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
integerCountintegercount
void NXOpen::LineDesigner::RailingFeatureBuilder::SetPostOffset ( NXOpen::LineDesigner::RailingFeatureBuilder::PostOffsetType  postOffset)

Sets the post offset of railing feature
Created in NX9.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
postOffsetpostoffset
void NXOpen::LineDesigner::RailingFeatureBuilder::SetSketchInternal ( bool  makeSketchInternal)

Sets an API to check if sketch is internal
Created in NX10.0.0.



License requirements : ld_line_designer ("FULL LINE DESIGNER")

Parameters
makeSketchInternalmakesketchinternal

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