NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder Class Reference

Represents a NXOpen::GeometricAnalysis::SectionAnalysisObject builder. More...

Inheritance diagram for NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CalculationMethodType { CalculationMethodTypeCurvature, CalculationMethodTypeRadiusofCurvature }
 The calculation method. More...
 
enum  NeedleDirectionType { NeedleDirectionTypeInside, NeedleDirectionTypeOutside }
 The needle direction. More...
 
enum  OutputType { OutputTypeAnalysisObject, OutputTypeSectionCurves, OutputTypeBoth }
 The output options. More...
 
enum  ScalingMethodType { ScalingMethodTypeLinear, ScalingMethodTypeLogarithmic }
 The scaling method. More...
 
enum  Types {
  TypesParallel, TypesIsoparametric, TypesAlongCurve, TypesQuadrilateral,
  TypesTriangular, TypesCircular
}
 Represents the sectioning types. More...
 

Public Member Functions

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CalculationMethodType CalculationMethod ()
 Returns the calculation method
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::CircularGridBuilderCircularGrid ()
 Returns the circular grid. More...
 
NXOpen::GeometricUtilities::CombOptionsBuilderCombOptions ()
 Returns the comb options
Created in NX6.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::NeedleDirectionType NeedleDirection ()
 Returns the needle direction
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::OutputType Output ()
 Returns the output
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::QuadrilateralGridBuilderQuadrilateralGrid ()
 Returns the quadrilateral grid. More...
 
NXOpen::SelectTaggedObjectListReferences ()
 Returns the references (faces or faceted bodies)
Created in NX6.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ScalingMethodType ScalingMethod ()
 Returns the scaling method
Created in NX7.0.0. More...
 
void SetCalculationMethod (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CalculationMethodType calculationMethod)
 Sets the calculation method
Created in NX7.0.0. More...
 
void SetNeedleDirection (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::NeedleDirectionType needleDirection)
 Sets the needle direction
Created in NX7.0.0. More...
 
void SetOutput (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::OutputType output)
 Sets the output
Created in NX7.0.0. More...
 
void SetScalingMethod (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ScalingMethodType scalingMethod)
 Sets the scaling method
Created in NX7.0.0. More...
 
void SetShowInflectionPoints (bool showInflectionPoints)
 Sets the flag to show the inflection points of planar sections
Created in NX6.0.0. More...
 
void SetShowPeakPoints (bool showPeakPoints)
 Sets the flag to show the peak points of the sections
Created in NX6.0.0. More...
 
void SetShowSectionLength (bool showSectionLength)
 Sets the flag to show the section length labels
Created in NX6.0.0. More...
 
void SetType (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::Types type)
 Sets the sectioning type
Created in NX6.0.0. More...
 
bool ShowInflectionPoints ()
 Returns the flag to show the inflection points of planar sections
Created in NX6.0.0. More...
 
bool ShowPeakPoints ()
 Returns the flag to show the peak points of the sections
Created in NX6.0.0. More...
 
bool ShowSectionLength ()
 Returns the flag to show the section length labels
Created in NX6.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::TriangularGridBuilderTriangularGrid ()
 Returns the triangular grid. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::Types Type ()
 Returns the sectioning type
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 NXOpen::GeometricAnalysis::SectionAnalysisObject builder.


To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollection::CreateSectionAnalysisBuilder
Default values.

Property Value

CalculationMethod

Curvature

CircularGrid.CircularFrame.AnchorAttachment

None

CircularGrid.CircularFrame.Subtype

Arbitrary

CircularGrid.Spacing.BoundSections1

True

CircularGrid.Spacing.BoundSections2

True

CircularGrid.Spacing.Interval1

45.0

CircularGrid.Spacing.Interval2

50.0 (millimeters part), 2.0 (inches part)

CircularGrid.Spacing.LockInterval1

False

CircularGrid.Spacing.LockInterval2

False

CircularGrid.Spacing.SectionNumber1

5

CircularGrid.Spacing.SectionNumber2

5

CircularGrid.SpecifiedPlane.Plane

View

NeedleDirection

Outside

Output

AnalysisObject

QuadrilateralGrid.QuadrilateralFrame.AnchorAttachment

None

QuadrilateralGrid.QuadrilateralFrame.Subtype

Arbitrary

ScalingMethod

Linear

ShowInflectionPoints

False

ShowPeakPoints

False

ShowSectionLength

False

TriangularGrid.TriangularFrame.AnchorAttachment

None

TriangularGrid.TriangularFrame.Subtype

Arbitrary

Type

Parallel


Created in NX6.0.0.

Member Enumeration Documentation

The calculation method.

Enumerator
CalculationMethodTypeCurvature 

Curvature.

CalculationMethodTypeRadiusofCurvature 

Radius of curvature.

The needle direction.

Enumerator
NeedleDirectionTypeInside 

Inside.

NeedleDirectionTypeOutside 

Outside.

The output options.

Enumerator
OutputTypeAnalysisObject 

Analysis Object.

OutputTypeSectionCurves 

section curves

OutputTypeBoth 

Both Analysis Object and section curves.

The scaling method.

Enumerator
ScalingMethodTypeLinear 

Linear.

ScalingMethodTypeLogarithmic 

Logarithmic.

Represents the sectioning types.

Enumerator
TypesParallel 

Parallel Planes.

TypesIsoparametric 

Isoparametric.

TypesAlongCurve 

Along Curve.

TypesQuadrilateral 

Quadrilateral.

TypesTriangular 

Triangular.

TypesCircular 

Circular.

Member Function Documentation

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CalculationMethodType NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CalculationMethod ( )

Returns the calculation method
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::CircularGridBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CircularGrid ( )

Returns the circular grid.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::TypesCircular
Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::GeometricUtilities::CombOptionsBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CombOptions ( )

Returns the comb options
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::NeedleDirectionType NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::NeedleDirection ( )

Returns the needle direction
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::OutputType NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::Output ( )

Returns the output
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::QuadrilateralGridBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::QuadrilateralGrid ( )

Returns the quadrilateral grid.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::TypesQuadrilateral
Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::SelectTaggedObjectList* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::References ( )

Returns the references (faces or faceted bodies)
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ScalingMethodType NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ScalingMethod ( )

Returns the scaling method
Created in NX7.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetCalculationMethod ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::CalculationMethodType  calculationMethod)

Sets the calculation method
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
calculationMethodcalculationmethod
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetNeedleDirection ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::NeedleDirectionType  needleDirection)

Sets the needle direction
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
needleDirectionneedledirection
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetOutput ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::OutputType  output)

Sets the output
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
outputoutput
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetScalingMethod ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ScalingMethodType  scalingMethod)

Sets the scaling method
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
scalingMethodscalingmethod
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetShowInflectionPoints ( bool  showInflectionPoints)

Sets the flag to show the inflection points of planar sections
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
showInflectionPointsshowinflectionpoints
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetShowPeakPoints ( bool  showPeakPoints)

Sets the flag to show the peak points of the sections
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
showPeakPointsshowpeakpoints
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetShowSectionLength ( bool  showSectionLength)

Sets the flag to show the section length labels
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
showSectionLengthshowsectionlength
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::SetType ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::Types  type)

Sets the sectioning type
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
typetype
bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ShowInflectionPoints ( )

Returns the flag to show the inflection points of planar sections
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ShowPeakPoints ( )

Returns the flag to show the peak points of the sections
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::ShowSectionLength ( )

Returns the flag to show the section length labels
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::GeometricAnalysis::SectionAnalysis::TriangularGridBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::TriangularGrid ( )

Returns the triangular grid.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::TypesTriangular
Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::Types NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisBuilder::Type ( )

Returns the sectioning type
Created in NX6.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")


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