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

Represents a NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExObject builder
To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollection::CreateSectionAnalysisExBuilder
Default values. More...

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

Public Types

enum  AlignmentType {
  AlignmentTypeXYZPlane, AlignmentTypeParallelPlanes, AlignmentTypeCurveAligned, AlignmentTypeIsoparametric,
  AlignmentTypeRadial
}
 The section alignment type. More...
 
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  PlacementType { PlacementTypeUniform, PlacementTypeThroughPoints, PlacementTypeBetweenPoints, PlacementTypeInteractive }
 The types of the section placement. More...
 
enum  ScalingMethodType { ScalingMethodTypeLinear, ScalingMethodTypeLogarithmic }
 The scaling method. More...
 

Public Member Functions

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentType Alignment ()
 Returns the alignment type
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::CalculationMethodType CalculationMethod ()
 Returns the calculation method
Created in NX7.0.0. More...
 
NXOpen::GeometricUtilities::CombOptionsBuilderCombOptions ()
 Returns the comb options specification
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::CurveAlignedBuilderCurveAligned ()
 Returns the Curve Aligned section specification. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::InteractiveBuilderInteractive ()
 Returns the Interactive placement specification. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::IsoparametricBuilderIsoparametric ()
 Returns the Isoparametric section specification. More...
 
bool IsShowInflectionPointsEnabled ()
 Returns a value indicating whether to show the inflection points
Created in NX7.0.0. More...
 
bool IsShowLengthEnabled ()
 Returns a value indicating whether to show the length of each section curve
Created in NX7.0.0. More...
 
bool IsShowPeakPointsEnabled ()
 Returns a value indicating whether to show the peak points
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::NeedleDirectionType NeedleDirection ()
 Returns the needle direction
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::OutputType Output ()
 Returns the output
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::ParallelPlanesExBuilderParallelPlanes ()
 Returns the Parallel Planes section specification. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::PlacementType Placement ()
 Returns the placement
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilderRadial ()
 Returns the Radial section specification. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::ScalingMethodType ScalingMethod ()
 Returns the scaling method
Created in NX7.0.0. More...
 
NXOpen::SelectTaggedObjectListSelectObject ()
 Returns the selected objects
Created in NX7.0.0. More...
 
void SetAlignment (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentType alignment)
 Sets the alignment type
Created in NX7.0.0. More...
 
void SetCalculationMethod (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::CalculationMethodType calculationMethod)
 Sets the calculation method
Created in NX7.0.0. More...
 
void SetNeedleDirection (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::NeedleDirectionType needleDirection)
 Sets the needle direction
Created in NX7.0.0. More...
 
void SetOutput (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::OutputType output)
 Sets the output
Created in NX7.0.0. More...
 
void SetPlacement (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::PlacementType placement)
 Sets the placement
Created in NX7.0.0. More...
 
void SetScalingMethod (NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::ScalingMethodType scalingMethod)
 Sets the scaling method
Created in NX7.0.0. More...
 
void SetShowInflectionPointsEnabled (bool inflection)
 Sets a value indicating whether to show the inflection points
Created in NX7.0.0. More...
 
void SetShowLengthEnabled (bool length)
 Sets a value indicating whether to show the length of each section curve
Created in NX7.0.0. More...
 
void SetShowPeakPointsEnabled (bool peak)
 Sets a value indicating whether to show the peak points
Created in NX7.0.0. More...
 
NXOpen::SelectPointListSpecifyPoint ()
 Returns the specified points
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::XYZPlaneBuilderXYZPlane ()
 Returns the XYZ Planes section specification. 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::SectionAnalysis::SectionAnalysisExObject builder
To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollection::CreateSectionAnalysisExBuilder
Default values.

Property Value

Alignment

XYZPlane

CalculationMethod

Curvature

CurveAligned.IsSpacingEnabled

0

CurveAligned.Number

5

CurveAligned.Offset

0

CurveAligned.Spacing

25

CurveAligned.SpecifiedPlane.Plane

View

CurveAligned.UseProjectedCurve

0

Interactive.IsCutInfiniteEnabled

0

IsShowInflectionPointsEnabled

0

IsShowLengthEnabled

0

IsShowPeakPointsEnabled

0

Isoparametric.IsSpacingEnabled

0

Isoparametric.IsUEnabled

1

Isoparametric.IsVEnabled

1

Isoparametric.Number

5

Isoparametric.Spacing

25

NeedleDirection

Outside

Output

AnalysisObject

ParallelPlanes.IsNumberEnabled

0

ParallelPlanes.IsSpacingEnabled

0

ParallelPlanes.Number

5

ParallelPlanes.Offset

0

ParallelPlanes.Spacing

50 (millimeters part), 2 (inches part)

Placement

Uniform

Radial.IsSpacingEnabled

0

Radial.Number

5

Radial.Offset

0

Radial.RotationAxis

View

Radial.Spacing

72

ScalingMethod

Linear

XYZPlane.IsNumberEnabled

0

XYZPlane.IsSpacingEnabled

0

XYZPlane.IsXEnabled

1

XYZPlane.IsYEnabled

1

XYZPlane.IsZEnabled

1

XYZPlane.Number

5

XYZPlane.Spacing

50 (millimeters part), 2 (inches part)


Created in NX7.0.0.

Member Enumeration Documentation

The section alignment type.

Enumerator
AlignmentTypeXYZPlane 

The cutting planes are perpendicular to X, Y or Z plane.

AlignmentTypeParallelPlanes 

The cutting planes are parallel to a specified plane.

AlignmentTypeCurveAligned 

The cutting planes are perpendicular to specified curves.

AlignmentTypeIsoparametric 

The sections are along isoparametric lines.

AlignmentTypeRadial 

The cutting planes are distributed along a circle.

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 types of the section placement.

Enumerator
PlacementTypeUniform 

Uniformly distributed.

PlacementTypeThroughPoints 

Through the specified points.

PlacementTypeBetweenPoints 

Distributed between two specified points.

PlacementTypeInteractive 

Interactively specified.

The scaling method.

Enumerator
ScalingMethodTypeLinear 

Linear.

ScalingMethodTypeLogarithmic 

Logarithmic.

Member Function Documentation

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentType NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::Alignment ( )

Returns the alignment type
Created in NX7.0.0.



License requirements : None

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

Returns the calculation method
Created in NX7.0.0.



License requirements : None

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

Returns the comb options specification
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::CurveAlignedBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::CurveAligned ( )

Returns the Curve Aligned section specification.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentTypeCurveAligned
Created in NX7.0.0.

License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::InteractiveBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::Interactive ( )

Returns the Interactive placement specification.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::PlacementTypeInteractive
Created in NX7.0.0.

License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::IsoparametricBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::Isoparametric ( )

Returns the Isoparametric section specification.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentTypeIsoparametric
Created in NX7.0.0.

License requirements : None

bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::IsShowInflectionPointsEnabled ( )

Returns a value indicating whether to show the inflection points
Created in NX7.0.0.



License requirements : None

bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::IsShowLengthEnabled ( )

Returns a value indicating whether to show the length of each section curve
Created in NX7.0.0.



License requirements : None

bool NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::IsShowPeakPointsEnabled ( )

Returns a value indicating whether to show the peak points
Created in NX7.0.0.



License requirements : None

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

Returns the needle direction
Created in NX7.0.0.



License requirements : None

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

Returns the output
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::ParallelPlanesExBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::ParallelPlanes ( )

Returns the Parallel Planes section specification.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentTypeParallelPlanes
Created in NX7.0.0.

License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::PlacementType NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::Placement ( )

Returns the placement
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::Radial ( )

Returns the Radial section specification.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentTypeCurveAligned
Created in NX7.0.0.

License requirements : None

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

Returns the scaling method
Created in NX7.0.0.



License requirements : None

NXOpen::SelectTaggedObjectList* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SelectObject ( )

Returns the selected objects
Created in NX7.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetAlignment ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentType  alignment)

Sets the alignment type
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
alignmentalignment
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetCalculationMethod ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::CalculationMethodType  calculationMethod)

Sets the calculation method
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

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

Sets the needle direction
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

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

Sets the output
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
outputoutput
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetPlacement ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::PlacementType  placement)

Sets the placement
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
placementplacement
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetScalingMethod ( NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::ScalingMethodType  scalingMethod)

Sets the scaling method
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
scalingMethodscalingmethod
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetShowInflectionPointsEnabled ( bool  inflection)

Sets a value indicating whether to show the inflection points
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
inflectioninflection
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetShowLengthEnabled ( bool  length)

Sets a value indicating whether to show the length of each section curve
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
lengthlength
void NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SetShowPeakPointsEnabled ( bool  peak)

Sets a value indicating whether to show the peak points
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
peakpeak
NXOpen::SelectPointList* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::SpecifyPoint ( )

Returns the specified points
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::XYZPlaneBuilder* NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::XYZPlane ( )

Returns the XYZ Planes section specification.

Only used when type is NXOpen::GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder::AlignmentTypeXYZPlane
Created in NX7.0.0.

License requirements : None


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