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

Represents the Radial specification for a GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder . More...

Inheritance diagram for NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RotationAxisType {
  RotationAxisTypeXc, RotationAxisTypeYc, RotationAxisTypeZc, RotationAxisTypeView,
  RotationAxisTypeArbitraryVector
}
 The type of the rotation axis. More...
 

Public Member Functions

bool IsSpacingEnabled ()
 Returns a value indicating whether the spacing is applied
Created in NX7.0.0. More...
 
int Number ()
 Returns a value indicating how many sections should created
Created in NX7.0.0. More...
 
double Offset ()
 Returns a value indicating the distance from the start position
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::RotationAxisType RotationAxis ()
 Returns a value indicating the type of the rotation axis
Created in NX7.0.0. More...
 
NXOpen::Vector3d RotationVector ()
 Returns the user specified rotation vector
Created in NX7.0.0. More...
 
void SetNumber (int number)
 Sets a value indicating how many sections should created
Created in NX7.0.0. More...
 
void SetOffset (double offset)
 Sets a value indicating the distance from the start position
Created in NX7.0.0. More...
 
void SetRotationAxis (NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::RotationAxisType rotationAxis)
 Sets a value indicating the type of the rotation axis
Created in NX7.0.0. More...
 
void SetRotationVector (const NXOpen::Vector3d &rotationVector)
 Sets the user specified rotation vector
Created in NX7.0.0. More...
 
void SetSpacing (double spacing)
 Sets a value indicating the space between sections
Created in NX7.0.0. More...
 
void SetSpacingEnabled (bool isSpacingEnabled)
 Sets a value indicating whether the spacing is applied
Created in NX7.0.0. More...
 
void SetSpecifiedRotationPoint (NXOpen::Point *specifiedRotationPoint)
 Sets the rotation point
Created in NX7.0.0. More...
 
double Spacing ()
 Returns a value indicating the space between sections
Created in NX7.0.0. More...
 
NXOpen::PointSpecifiedRotationPoint ()
 Returns the rotation point
Created in NX7.0.0. More...
 
NXOpen::SelectPointStartPosition ()
 Returns the start position
Created in NX7.0.0. 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 the Radial specification for a GeometricAnalysis::SectionAnalysis::SectionAnalysisExBuilder .


Created in NX7.0.0.

Member Enumeration Documentation

The type of the rotation axis.

Enumerator
RotationAxisTypeXc 

XC axis.

RotationAxisTypeYc 

YC axis.

RotationAxisTypeZc 

ZC axis.

RotationAxisTypeView 

View direction.

RotationAxisTypeArbitraryVector 

A user specified vector.

Member Function Documentation

bool NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::IsSpacingEnabled ( )

Returns a value indicating whether the spacing is applied
Created in NX7.0.0.



License requirements : None

int NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::Number ( )

Returns a value indicating how many sections should created
Created in NX7.0.0.



License requirements : None

double NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::Offset ( )

Returns a value indicating the distance from the start position
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::RotationAxisType NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::RotationAxis ( )

Returns a value indicating the type of the rotation axis
Created in NX7.0.0.



License requirements : None

NXOpen::Vector3d NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::RotationVector ( )

Returns the user specified rotation vector
Created in NX7.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetNumber ( int  number)

Sets a value indicating how many sections should created
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
numbernumber
void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetOffset ( double  offset)

Sets a value indicating the distance from the start position
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
offsetoffset
void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetRotationAxis ( NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::RotationAxisType  rotationAxis)

Sets a value indicating the type of the rotation axis
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
rotationAxisrotationaxis
void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetRotationVector ( const NXOpen::Vector3d rotationVector)

Sets the user specified rotation vector
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
rotationVectorrotationvector
void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetSpacing ( double  spacing)

Sets a value indicating the space between sections
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
spacingspacing
void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetSpacingEnabled ( bool  isSpacingEnabled)

Sets a value indicating whether the spacing is applied
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
isSpacingEnabledisspacingenabled
void NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SetSpecifiedRotationPoint ( NXOpen::Point specifiedRotationPoint)

Sets the rotation point
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters
specifiedRotationPointspecifiedrotationpoint
double NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::Spacing ( )

Returns a value indicating the space between sections
Created in NX7.0.0.



License requirements : None

NXOpen::Point* NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::SpecifiedRotationPoint ( )

Returns the rotation point
Created in NX7.0.0.



License requirements : None

NXOpen::SelectPoint* NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::StartPosition ( )

Returns the start position
Created in NX7.0.0.



License requirements : None

virtual bool NXOpen::GeometricAnalysis::SectionAnalysis::RadialBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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