NX Open C++ Reference Guide
Public Types | Public Member Functions
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

List of all members.

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

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
numbernumber

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



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
offsetoffset

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



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
rotationAxisrotationaxis

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



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
rotationVectorrotationvector

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



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
spacingspacing

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



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
isSpacingEnabledisspacingenabled

Sets the rotation point
Created in NX7.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
specifiedRotationPointspecifiedrotationpoint

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



License requirements : None

Returns the rotation point
Created in NX7.0.0.



License requirements : None

Returns the start position
Created in NX7.0.0.



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.