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

Represents a NCAssistant Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateNCAssistantBuilder
Default values. More...

Inheritance diagram for NXOpen::CAM::NCAssistantBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AnalysisTypes { AnalysisTypesLevels, AnalysisTypesCorners, AnalysisTypesBlends, AnalysisTypesDraft }
 Analysis Type. More...
 

Public Member Functions

NXOpen::CAM::NCAssistantBuilder::AnalysisTypes AnalysisType ()
 Returns the Analysis Type
Created in NX7.5.0. More...
 
void AnalyzeGeometry ()
 The action of Analyze Geometry button. More...
 
double AngleTolerance ()
 Returns the Angle Tolerance
Created in NX7.5.0. More...
 
double DistanceTolerance ()
 Returns the Distance Tolerance
Created in NX7.5.0. More...
 
NXOpen::SelectFaceListFacesToAnalyze ()
 Returns the Faces to Analyze
Created in NX7.5.0. More...
 
bool GetResults (std::vector< NXOpen::Face * > &analyzedFaces, std::vector< double > &doubleValue)
 The analyze result. More...
 
void Information ()
 The action of Information button. More...
 
double MaximumAngle ()
 Returns the Maximum Angle
Created in NX7.5.0. More...
 
double MaximumLevel ()
 Returns the Maximum Level
Created in NX7.5.0. More...
 
double MaximumRadius ()
 Returns the Maximum Radius
Created in NX7.5.0. More...
 
double MinimumAngle ()
 Returns the Minimum Angle
Created in NX7.5.0. More...
 
double MinimumLevel ()
 Returns the Minimum Level
Created in NX7.5.0. More...
 
double MinimumRadius ()
 Returns the Minimum Radius
Created in NX7.5.0. More...
 
double RadiusTolerance ()
 Returns the Radius Tolerance
Created in NX7.5.0. More...
 
NXOpen::PlaneReferencePlane ()
 Returns the Reference Plane
Created in NX7.5.0. More...
 
NXOpen::DirectionReferenceVector ()
 Returns the Reference Vector
Created in NX7.5.0. More...
 
bool SaveFaceColors ()
 Returns the Save Face Colors on Exit
Created in NX7.5.0. More...
 
void SetAnalysisType (NXOpen::CAM::NCAssistantBuilder::AnalysisTypes analysisType)
 Sets the Analysis Type
Created in NX7.5.0. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the Angle Tolerance
Created in NX7.5.0. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the Distance Tolerance
Created in NX7.5.0. More...
 
void SetMaximumAngle (double maximum)
 Sets the Maximum Angle
Created in NX7.5.0. More...
 
void SetMaximumLevel (double maximum)
 Sets the Maximum Level
Created in NX7.5.0. More...
 
void SetMaximumRadius (double maximum)
 Sets the Maximum Radius
Created in NX7.5.0. More...
 
void SetMinimumAngle (double minimum)
 Sets the Minimum Angle
Created in NX7.5.0. More...
 
void SetMinimumLevel (double minimum)
 Sets the Minimum Level
Created in NX7.5.0. More...
 
void SetMinimumRadius (double minimum)
 Sets the Minimum Radius
Created in NX7.5.0. More...
 
void SetRadiusTolerance (double radiusTolerance)
 Sets the Radius Tolerance
Created in NX7.5.0. More...
 
void SetReferencePlane (NXOpen::Plane *referencePlane)
 Sets the Reference Plane
Created in NX7.5.0. More...
 
void SetReferenceVector (NXOpen::Direction *referenceVector)
 Sets the Reference Vector
Created in NX7.5.0. More...
 
void SetSaveFaceColors (bool saveFaceColorsOnExit)
 Sets the Save Face Colors on Exit
Created in NX7.5.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 NCAssistant Builder
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateNCAssistantBuilder
Default values.

Property Value

AnalysisType

Levels

AngleTolerance

0.01 (millimeters part), 0.01 (inches part)

DistanceTolerance

0.01 (millimeters part), 0.0004 (inches part)

MaximumAngle

90.00 (millimeters part), 90.00 (inches part)

MaximumLevel

1000.00 (millimeters part), 50.00 (inches part)

MaximumRadius

50.00 (millimeters part), 2.00 (inches part)

MinimumAngle

-90.00 (millimeters part), -90.00 (inches part)

MinimumLevel

-1000.00 (millimeters part), -50.00 (inches part)

MinimumRadius

-50.00 (millimeters part), -2.00 (inches part)

RadiusTolerance

0.01 (millimeters part), 0.0004 (inches part)


Created in NX7.5.0.

Member Enumeration Documentation

Analysis Type.

Enumerator
AnalysisTypesLevels 

Analysis Type: Levels.

AnalysisTypesCorners 

Analysis Type: Corners.

AnalysisTypesBlends 

Analysis Type: Blens.

AnalysisTypesDraft 

Analysis Type: Draft.

Member Function Documentation

NXOpen::CAM::NCAssistantBuilder::AnalysisTypes NXOpen::CAM::NCAssistantBuilder::AnalysisType ( )

Returns the Analysis Type
Created in NX7.5.0.



License requirements : None

void NXOpen::CAM::NCAssistantBuilder::AnalyzeGeometry ( )

The action of Analyze Geometry button.


Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

double NXOpen::CAM::NCAssistantBuilder::AngleTolerance ( )

Returns the Angle Tolerance
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::DistanceTolerance ( )

Returns the Distance Tolerance
Created in NX7.5.0.



License requirements : None

NXOpen::SelectFaceList* NXOpen::CAM::NCAssistantBuilder::FacesToAnalyze ( )

Returns the Faces to Analyze
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::NCAssistantBuilder::GetResults ( std::vector< NXOpen::Face * > &  analyzedFaces,
std::vector< double > &  doubleValue 
)

The analyze result.

After analyzing the selected faces,it will return the analyzed faces and the corresponding double values,including depth, corner or fillets radius or draft angle.

Returns
success or not
Created in NX7.5.0.

License requirements : None
Parameters
analyzedFacesthe faces found during analyze run, it is need SM_free
doubleValuethe corresponding analysis value of the face, depth, corner or fillets radius or draft angle
void NXOpen::CAM::NCAssistantBuilder::Information ( )

The action of Information button.

It will bring out a text dialog
Created in NX7.5.0.

License requirements : cam_base ("CAM BASE")

double NXOpen::CAM::NCAssistantBuilder::MaximumAngle ( )

Returns the Maximum Angle
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::MaximumLevel ( )

Returns the Maximum Level
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::MaximumRadius ( )

Returns the Maximum Radius
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::MinimumAngle ( )

Returns the Minimum Angle
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::MinimumLevel ( )

Returns the Minimum Level
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::MinimumRadius ( )

Returns the Minimum Radius
Created in NX7.5.0.



License requirements : None

double NXOpen::CAM::NCAssistantBuilder::RadiusTolerance ( )

Returns the Radius Tolerance
Created in NX7.5.0.



License requirements : None

NXOpen::Plane* NXOpen::CAM::NCAssistantBuilder::ReferencePlane ( )

Returns the Reference Plane
Created in NX7.5.0.



License requirements : None

NXOpen::Direction* NXOpen::CAM::NCAssistantBuilder::ReferenceVector ( )

Returns the Reference Vector
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::NCAssistantBuilder::SaveFaceColors ( )

Returns the Save Face Colors on Exit
Created in NX7.5.0.



License requirements : None

void NXOpen::CAM::NCAssistantBuilder::SetAnalysisType ( NXOpen::CAM::NCAssistantBuilder::AnalysisTypes  analysisType)

Sets the Analysis Type
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
analysisTypethe Analysis Type
void NXOpen::CAM::NCAssistantBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the Angle Tolerance
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
angleTolerancethe Angle Tolerance
void NXOpen::CAM::NCAssistantBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the Distance Tolerance
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
distanceTolerancethe Distance Tolerance
void NXOpen::CAM::NCAssistantBuilder::SetMaximumAngle ( double  maximum)

Sets the Maximum Angle
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
maximumthe Maximum Angle
void NXOpen::CAM::NCAssistantBuilder::SetMaximumLevel ( double  maximum)

Sets the Maximum Level
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
maximumthe Maximum Level
void NXOpen::CAM::NCAssistantBuilder::SetMaximumRadius ( double  maximum)

Sets the Maximum Radius
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
maximumthe Maximum Radius
void NXOpen::CAM::NCAssistantBuilder::SetMinimumAngle ( double  minimum)

Sets the Minimum Angle
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
minimumthe Minimum Angle
void NXOpen::CAM::NCAssistantBuilder::SetMinimumLevel ( double  minimum)

Sets the Minimum Level
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
minimumthe Minimum Level
void NXOpen::CAM::NCAssistantBuilder::SetMinimumRadius ( double  minimum)

Sets the Minimum Radius
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
minimumthe Minimum Radius
void NXOpen::CAM::NCAssistantBuilder::SetRadiusTolerance ( double  radiusTolerance)

Sets the Radius Tolerance
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
radiusTolerancethe Radius Tolerance
void NXOpen::CAM::NCAssistantBuilder::SetReferencePlane ( NXOpen::Plane referencePlane)

Sets the Reference Plane
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
referencePlanethe Reference Plane
void NXOpen::CAM::NCAssistantBuilder::SetReferenceVector ( NXOpen::Direction referenceVector)

Sets the Reference Vector
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
referenceVectorthe Reference Vector
void NXOpen::CAM::NCAssistantBuilder::SetSaveFaceColors ( bool  saveFaceColorsOnExit)

Sets the Save Face Colors on Exit
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
saveFaceColorsOnExitthe Save Face Colors on Exit

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