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

Represents a CMM Inspection Curve Feature builder
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionCurveFeatureBuilder

Created in NX7.0.0. More...

Inheritance diagram for NXOpen::CAM::InspectionCurveFeatureBuilder:
NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PointDataDefinitionType { PointDataDefinitionTypeNone, PointDataDefinitionTypePointSet, PointDataDefinitionTypeIndividualPoints }
 The method used to define point data. More...
 
enum  StartEndModeType { StartEndModeTypePercentage, StartEndModeTypeDistance }
 the method used to define the start and end points More...
 
- Public Types inherited from NXOpen::CAM::OperationBuilder
enum  HoleAxisTypes { HoleAxisTypesVector, HoleAxisTypesRule, HoleAxisTypesRuleIfNoVector }
 Available types for Hole Axis Type in feature milling and hole making. More...
 
enum  HoleDepthTypes { HoleDepthTypesPoint, HoleDepthTypesRule }
 Available types for Hole Depth Type in feature milling and hole making. More...
 
enum  OptimizationBasedOnTypes { OptimizationBasedOnTypesDist, OptimizationBasedOnTypesOrient }
 Available types for optimization based on in operation. More...
 
enum  OptimizationDistanceTypes { OptimizationDistanceTypesDirect, OptimizationDistanceTypesTransition }
 Available types for optimization distance method in operation. More...
 
enum  OptimizationLevelTypes { OptimizationLevelTypesStandard, OptimizationLevelTypesAdvanced }
 Available types for optimization level in operation. More...
 
- Public Types inherited from NXOpen::CAM::ParamBuilder
enum  OptimizationTypes { OptimizationTypesNone, OptimizationTypesMinimizeTravel, OptimizationTypesBand }
 Available types for Optimization Method in operation. More...
 

Public Member Functions

NXOpen::DirectionApproachDirection ()
 Returns the approach direction
Created in NX7.0.0. More...
 
double CurvatureFactor ()
 Returns the curvature factor
Created in NX8.5.1. More...
 
double EndDistance ()
 Returns the end distance
Created in NX8.5.1. More...
 
double EndPercentage ()
 Returns the end percentage
Created in NX8.5.1. More...
 
void ErasePointDefinitionDisplay ()
 Erases display of point definition data
Created in NX9.0.0. More...
 
bool IsPointDefinitionChanged ()
 Returns the point data definition changed flag
Created in NX9.0.0. More...
 
double MaximumSpacing ()
 Returns the maximum spacing
Created in NX8.5.1. More...
 
int MinimumNumberOfPoints ()
 Returns the minimum number of points
Created in NX8.5.1. More...
 
double MinimumSpacing ()
 Returns the minimum spacing
Created in NX8.5.1. More...
 
NXString Name ()
 Returns the name
Created in NX7.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderOffsetDistance ()
 Returns the offset distance
Created in NX9.0.0. More...
 
NXOpen::CAM::InspectionCurveFeatureBuilder::PointDataDefinitionType PointDataDefinition ()
 Returns the point data definition
Created in NX8.5.1. More...
 
NXOpen::SelectPointListPointSelector ()
 Returns the user specified point selector
Created in NX8.5.1. More...
 
void PreviewPointData (bool showExisting)
 Creates preview of point definition data
Created in NX9.0.0. More...
 
void ReverseFeatureNormal ()
 Reverses the feature normal
Created in NX9.0.0. More...
 
void ReverseOffsetDirection ()
 Reverses the offset direction
Created in NX9.0.0. More...
 
NXOpen::SelectNXObjectListSelectedCurves ()
 Returns the selected curves
Created in NX7.0.0. More...
 
NXOpen::SelectNXObjectListSelectedSurfaces ()
 Returns the underlying surfaces selector. More...
 
void SetApproachDirection (NXOpen::Direction *approachDirection)
 Sets the approach direction
Created in NX7.0.0. More...
 
void SetCurvatureFactor (double curvatureFactor)
 Sets the curvature factor
Created in NX8.5.1. More...
 
void SetEndDistance (double endDistance)
 Sets the end distance
Created in NX8.5.1. More...
 
void SetEndPercentage (double endPercentage)
 Sets the end percentage
Created in NX8.5.1. More...
 
void SetMaximumSpacing (double maximumSpacing)
 Sets the maximum spacing
Created in NX8.5.1. More...
 
void SetMinimumNumberOfPoints (int minimumNumberOfPoints)
 Sets the minimum number of points
Created in NX8.5.1. More...
 
void SetMinimumSpacing (double minimumSpacing)
 Sets the minimum spacing
Created in NX8.5.1. More...
 
void SetName (const NXString &name)
 Sets the name
Created in NX7.0.0. More...
 
void SetName (const char *name)
 Sets the name
Created in NX7.0.0. More...
 
void SetPointDataDefinition (NXOpen::CAM::InspectionCurveFeatureBuilder::PointDataDefinitionType pointDataDefinition)
 Sets the point data definition
Created in NX8.5.1. More...
 
void SetPointDefinitionChanged (bool isChanged)
 Sets the point data definition changed flag
Created in NX9.0.0. More...
 
void SetSelectedSurfaces (const std::vector< NXOpen::Face * > &selectedSurfaces)
 Sets the curve underlying selected surfaces
Created in NX9.0.0. More...
 
void SetStartDistance (double startDistance)
 Sets the start distance
Created in NX8.5.1. More...
 
void SetStartEndMode (NXOpen::CAM::InspectionCurveFeatureBuilder::StartEndModeType startEndMode)
 Sets the start end mode
Created in NX8.5.1. More...
 
void SetStartPercentage (double startPercentage)
 Sets the start percentage
Created in NX8.5.1. More...
 
double StartDistance ()
 Returns the start distance
Created in NX8.5.1. More...
 
NXOpen::CAM::InspectionCurveFeatureBuilder::StartEndModeType StartEndMode ()
 Returns the start end mode
Created in NX8.5.1. More...
 
double StartPercentage ()
 Returns the start percentage
Created in NX8.5.1. More...
 
void UpdateOffset ()
 Updates curve inspection feature characteristic parameters based on offset distance
Created in NX9.0.0. More...
 
void UpdateParams ()
 Updates the feature parameters
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::OperationBuilder
NXString ChannelName ()
 Returns the channel's name
Created in NX7.5.0. More...
 
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderEndOfPath ()
 Returns the end event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::GeometryCiBuilderGeometry ()
 Returns the geometry builder
Created in NX5.0.0. More...
 
std::vector< double > GetHoleAxisValues ()
 Get the Hole Axis values. More...
 
bool GougeChecking ()
 Returns the gouge checking flag
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleAxisTypes HoleAxisType ()
 Returns the Hole Axis Type
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHoleDepth ()
 Returns the max depth distance builder
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleDepthTypes HoleDepthType ()
 Returns the Hole Depth Type
Created in NX5.0.0. More...
 
NXOpen::CAM::LayoutCiBuilderLayoutAndLayer ()
 Returns the Layer and Layout
Created in NX9.0.1. More...
 
NXOpen::CAM::ArcOutputTypeCiBuilderMotionOutputBuilder ()
 Returns the motion output builder
Created in NX8.0.0. More...
 
NXOpen::CAM::NotesNotes ()
 Returns the notes builder
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes OptimizationBasedOn ()
 Returns the optimization based on in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes OptimizationDistanceMethod ()
 Returns the optimization distance method in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationLevelTypes OptimizationLevel ()
 Returns the optimization level in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationDisplayOptionsBuilderPathDisplayOptions ()
 Returns the path display options builder
Created in NX6.0.0. More...
 
NXString PostToolPathExit ()
 Returns the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistance ()
 Returns the Retract Distance builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistanceOnToolAxisChange ()
 Returns the Retract Distance on Tool Axis Change builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderSafeClearance ()
 Returns the safe clearance builder
Created in NX6.0.0. More...
 
bool SelectToolFlag ()
 Returns the user selected tool
Created in NX5.0.0. More...
 
void SetChannelName (const NXString &channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetChannelName (const char *channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX9.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX9.0.0. More...
 
void SetGougeChecking (bool gougeChecking)
 Sets the gouge checking flag
Created in NX9.0.0. More...
 
void SetHoleAxisType (NXOpen::CAM::OperationBuilder::HoleAxisTypes types)
 Sets the Hole Axis Type
Created in NX5.0.0. More...
 
void SetHoleAxisValues (const std::vector< double > &holeAxis)
 Set the Hole Axis values
Created in NX5.0.0. More...
 
void SetHoleDepthType (NXOpen::CAM::OperationBuilder::HoleDepthTypes types)
 Sets the Hole Depth Type
Created in NX5.0.0. More...
 
void SetOptimizationBasedOn (NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn)
 Sets the optimization based on in operation
Created in NX5.0.0. More...
 
void SetOptimizationDistanceMethod (NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance)
 Sets the optimization distance method in operation
Created in NX5.0.0. More...
 
void SetOptimizationLevel (NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType)
 Sets the optimization level in operation
Created in NX5.0.0. More...
 
void SetPostToolPathExit (const NXString &exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetPostToolPathExit (const char *exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetSelectToolFlag (bool selToolFlag)
 Sets the user selected tool
Created in NX5.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderStartOfPath ()
 Returns the start event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::ToolChangeCiBuilderToolChangeSetting ()
 Returns the tool change builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ToolPathEditorBuilderToolPathEditor ()
 Returns the Tool Path Editor Builder
Created in NX9.0.3. More...
 
NXOpen::CAM::ToolPathSplitParametersBuilderToolPathSplitParametersBuilder ()
 Returns the tool path split Parameters
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::UdeCycleEvent ()
 Returns the cycle event
Created in NX7.5.0. More...
 
NXOpen::CAM::CycleCycleTable ()
 Returns the cycle
Created in NX9.0.0. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for the given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for the given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
NXOpen::CAM::ParamBuilder::OptimizationTypes OptimizationMethod ()
 Returns the optim method
Created in NX5.0.0. More...
 
void SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
 Sets the optim method
Created in NX5.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 CMM Inspection Curve Feature builder
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionCurveFeatureBuilder

Created in NX7.0.0.


Member Enumeration Documentation

The method used to define point data.

Enumerator
PointDataDefinitionTypeNone 

No point data is defined.

PointDataDefinitionTypePointSet 

A set of points are defined using parameters.

PointDataDefinitionTypeIndividualPoints 

Individual points are defined.

the method used to define the start and end points

Enumerator
StartEndModeTypePercentage 

Percent.

StartEndModeTypeDistance 

Distance.

Member Function Documentation

NXOpen::Direction* NXOpen::CAM::InspectionCurveFeatureBuilder::ApproachDirection ( )

Returns the approach direction
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionCurveFeatureBuilder::CurvatureFactor ( )

Returns the curvature factor
Created in NX8.5.1.



License requirements : None

double NXOpen::CAM::InspectionCurveFeatureBuilder::EndDistance ( )

Returns the end distance
Created in NX8.5.1.



License requirements : None

double NXOpen::CAM::InspectionCurveFeatureBuilder::EndPercentage ( )

Returns the end percentage
Created in NX8.5.1.



License requirements : None

void NXOpen::CAM::InspectionCurveFeatureBuilder::ErasePointDefinitionDisplay ( )

Erases display of point definition data
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

bool NXOpen::CAM::InspectionCurveFeatureBuilder::IsPointDefinitionChanged ( )

Returns the point data definition changed flag
Created in NX9.0.0.



License requirements : None

double NXOpen::CAM::InspectionCurveFeatureBuilder::MaximumSpacing ( )

Returns the maximum spacing
Created in NX8.5.1.



License requirements : None

int NXOpen::CAM::InspectionCurveFeatureBuilder::MinimumNumberOfPoints ( )

Returns the minimum number of points
Created in NX8.5.1.



License requirements : None

double NXOpen::CAM::InspectionCurveFeatureBuilder::MinimumSpacing ( )

Returns the minimum spacing
Created in NX8.5.1.



License requirements : None

NXString NXOpen::CAM::InspectionCurveFeatureBuilder::Name ( )

Returns the name
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionCurveFeatureBuilder::OffsetDistance ( )

Returns the offset distance
Created in NX9.0.0.



License requirements : None

NXOpen::CAM::InspectionCurveFeatureBuilder::PointDataDefinitionType NXOpen::CAM::InspectionCurveFeatureBuilder::PointDataDefinition ( )

Returns the point data definition
Created in NX8.5.1.



License requirements : None

NXOpen::SelectPointList* NXOpen::CAM::InspectionCurveFeatureBuilder::PointSelector ( )

Returns the user specified point selector
Created in NX8.5.1.



License requirements : None

void NXOpen::CAM::InspectionCurveFeatureBuilder::PreviewPointData ( bool  showExisting)

Creates preview of point definition data
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
showExistingshowexisting
void NXOpen::CAM::InspectionCurveFeatureBuilder::ReverseFeatureNormal ( )

Reverses the feature normal
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionCurveFeatureBuilder::ReverseOffsetDirection ( )

Reverses the offset direction
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::SelectNXObjectList* NXOpen::CAM::InspectionCurveFeatureBuilder::SelectedCurves ( )

Returns the selected curves
Created in NX7.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::CAM::InspectionCurveFeatureBuilder::SelectedSurfaces ( )

Returns the underlying surfaces selector.


Created in NX7.0.0.

License requirements : None

void NXOpen::CAM::InspectionCurveFeatureBuilder::SetApproachDirection ( NXOpen::Direction approachDirection)

Sets the approach direction
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
approachDirectionapproachdirection
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetCurvatureFactor ( double  curvatureFactor)

Sets the curvature factor
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
curvatureFactorcurvaturefactor
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetEndDistance ( double  endDistance)

Sets the end distance
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
endDistanceenddistance
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetEndPercentage ( double  endPercentage)

Sets the end percentage
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
endPercentageendpercentage
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetMaximumSpacing ( double  maximumSpacing)

Sets the maximum spacing
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
maximumSpacingmaximumspacing
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetMinimumNumberOfPoints ( int  minimumNumberOfPoints)

Sets the minimum number of points
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
minimumNumberOfPointsminimumnumberofpoints
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetMinimumSpacing ( double  minimumSpacing)

Sets the minimum spacing
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
minimumSpacingminimumspacing
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetName ( const NXString name)

Sets the name
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
namename
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetName ( const char *  name)

Sets the name
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
namename
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetPointDataDefinition ( NXOpen::CAM::InspectionCurveFeatureBuilder::PointDataDefinitionType  pointDataDefinition)

Sets the point data definition
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
pointDataDefinitionpointdatadefinition
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetPointDefinitionChanged ( bool  isChanged)

Sets the point data definition changed flag
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
isChangedischanged
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetSelectedSurfaces ( const std::vector< NXOpen::Face * > &  selectedSurfaces)

Sets the curve underlying selected surfaces
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
selectedSurfacesArray of selected surfaces
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetStartDistance ( double  startDistance)

Sets the start distance
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
startDistancestartdistance
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetStartEndMode ( NXOpen::CAM::InspectionCurveFeatureBuilder::StartEndModeType  startEndMode)

Sets the start end mode
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
startEndModestartendmode
void NXOpen::CAM::InspectionCurveFeatureBuilder::SetStartPercentage ( double  startPercentage)

Sets the start percentage
Created in NX8.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
startPercentagestartpercentage
double NXOpen::CAM::InspectionCurveFeatureBuilder::StartDistance ( )

Returns the start distance
Created in NX8.5.1.



License requirements : None

NXOpen::CAM::InspectionCurveFeatureBuilder::StartEndModeType NXOpen::CAM::InspectionCurveFeatureBuilder::StartEndMode ( )

Returns the start end mode
Created in NX8.5.1.



License requirements : None

double NXOpen::CAM::InspectionCurveFeatureBuilder::StartPercentage ( )

Returns the start percentage
Created in NX8.5.1.



License requirements : None

void NXOpen::CAM::InspectionCurveFeatureBuilder::UpdateOffset ( )

Updates curve inspection feature characteristic parameters based on offset distance
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionCurveFeatureBuilder::UpdateParams ( )

Updates the feature parameters
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")


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