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

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

Created in NX7.0.0. More...

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

Public Member Functions

double BasePointX ()
 Returns the base point or plane center X coordinate
Created in NX7.0.0. More...
 
double BasePointY ()
 Returns the base point or plane center Y coordinate
Created in NX7.0.0. More...
 
double BasePointZ ()
 Returns the base point or plane center Z coordinate
Created in NX7.0.0. More...
 
NXOpen::CAM::CamInspectionOperationCsysreferencetypes CsysReferenceType ()
 Returns the csys reference type
Created in NX7.0.0. More...
 
NXOpen::CAM::CamInspectionOperationExtenttypes ExtentType ()
 Returns the extent type
Created in NX7.0.0. More...
 
void FlipNormal ()
 Flips the plane inspection feature normal vector
Created in NX7.0.0. More...
 
NXString Name ()
 Returns the plane inspection feature name
Created in NX7.0.0. More...
 
NXOpen::DirectionNormalVector ()
 Returns the normal vector
Created in NX7.0.0. More...
 
double NormalVectorI ()
 Returns the normal vector I component
Created in NX7.0.0. More...
 
double NormalVectorJ ()
 Returns the normal vector J component
Created in NX7.0.0. More...
 
double NormalVectorK ()
 Returns the normal vector K component
Created in NX7.0.0. More...
 
bool ReverseFaceNormal ()
 Returns the reverse face normal flag
Created in NX7.0.0. More...
 
NXOpen::SelectNXObjectListSelectedPlane ()
 Returns the selected plane
Created in NX7.0.0. More...
 
void SetBasePointX (double basePointX)
 Sets the base point or plane center X coordinate
Created in NX7.0.0. More...
 
void SetBasePointY (double basePointY)
 Sets the base point or plane center Y coordinate
Created in NX7.0.0. More...
 
void SetBasePointZ (double basePointZ)
 Sets the base point or plane center Z coordinate
Created in NX7.0.0. More...
 
void SetCsysReferenceType (NXOpen::CAM::CamInspectionOperationCsysreferencetypes csysReferenceType)
 Sets the csys reference type
Created in NX7.0.0. More...
 
void SetExtentType (NXOpen::CAM::CamInspectionOperationExtenttypes extentType)
 Sets the extent type
Created in NX7.0.0. More...
 
void SetName (const NXString &name)
 Sets the plane inspection feature name
Created in NX7.0.0. More...
 
void SetName (const char *name)
 Sets the plane inspection feature name
Created in NX7.0.0. More...
 
void SetNormalVector (NXOpen::Direction *normalVector)
 Sets the normal vector
Created in NX7.0.0. More...
 
void SetNormalVectorI (double normalVectorI)
 Sets the normal vector I component
Created in NX7.0.0. More...
 
void SetNormalVectorJ (double normalVectorJ)
 Sets the normal vector J component
Created in NX7.0.0. More...
 
void SetNormalVectorK (double normalVectorK)
 Sets the normal vector K component
Created in NX7.0.0. More...
 
void SetReverseFaceNormal (bool reverseFaceNormal)
 Sets the reverse face normal flag
Created in NX7.0.0. More...
 
void UpdateNormalVector (const NXOpen::Vector3d &vector)
 Updates plane inspection feature normal vector based on selected vector
Created in NX7.0.0. More...
 
void UpdateParams ()
 Updates plane inspection feature characteristic parameters based on selected geometry
Created in NX7.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...
 

Additional Inherited Members

- 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...
 

Detailed Description

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

Created in NX7.0.0.


Member Function Documentation

double NXOpen::CAM::InspectionPlaneFeatureBuilder::BasePointX ( )

Returns the base point or plane center X coordinate
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionPlaneFeatureBuilder::BasePointY ( )

Returns the base point or plane center Y coordinate
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionPlaneFeatureBuilder::BasePointZ ( )

Returns the base point or plane center Z coordinate
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::CamInspectionOperationCsysreferencetypes NXOpen::CAM::InspectionPlaneFeatureBuilder::CsysReferenceType ( )

Returns the csys reference type
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::CamInspectionOperationExtenttypes NXOpen::CAM::InspectionPlaneFeatureBuilder::ExtentType ( )

Returns the extent type
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionPlaneFeatureBuilder::FlipNormal ( )

Flips the plane inspection feature normal vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXString NXOpen::CAM::InspectionPlaneFeatureBuilder::Name ( )

Returns the plane inspection feature name
Created in NX7.0.0.



License requirements : None

NXOpen::Direction* NXOpen::CAM::InspectionPlaneFeatureBuilder::NormalVector ( )

Returns the normal vector
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionPlaneFeatureBuilder::NormalVectorI ( )

Returns the normal vector I component
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionPlaneFeatureBuilder::NormalVectorJ ( )

Returns the normal vector J component
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionPlaneFeatureBuilder::NormalVectorK ( )

Returns the normal vector K component
Created in NX7.0.0.



License requirements : None

bool NXOpen::CAM::InspectionPlaneFeatureBuilder::ReverseFaceNormal ( )

Returns the reverse face normal flag
Created in NX7.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::CAM::InspectionPlaneFeatureBuilder::SelectedPlane ( )

Returns the selected plane
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetBasePointX ( double  basePointX)

Sets the base point or plane center X coordinate
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
basePointXbasepointx
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetBasePointY ( double  basePointY)

Sets the base point or plane center Y coordinate
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
basePointYbasepointy
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetBasePointZ ( double  basePointZ)

Sets the base point or plane center Z coordinate
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
basePointZbasepointz
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetCsysReferenceType ( NXOpen::CAM::CamInspectionOperationCsysreferencetypes  csysReferenceType)

Sets the csys reference type
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
csysReferenceTypecsysreferencetype
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetExtentType ( NXOpen::CAM::CamInspectionOperationExtenttypes  extentType)

Sets the extent type
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
extentTypeextenttype
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetName ( const NXString name)

Sets the plane inspection feature name
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

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

Sets the plane inspection feature name
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
namename
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetNormalVector ( NXOpen::Direction normalVector)

Sets the normal vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
normalVectornormalvector
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetNormalVectorI ( double  normalVectorI)

Sets the normal vector I component
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
normalVectorInormalvectori
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetNormalVectorJ ( double  normalVectorJ)

Sets the normal vector J component
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
normalVectorJnormalvectorj
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetNormalVectorK ( double  normalVectorK)

Sets the normal vector K component
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
normalVectorKnormalvectork
void NXOpen::CAM::InspectionPlaneFeatureBuilder::SetReverseFaceNormal ( bool  reverseFaceNormal)

Sets the reverse face normal flag
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reverseFaceNormalreversefacenormal
void NXOpen::CAM::InspectionPlaneFeatureBuilder::UpdateNormalVector ( const NXOpen::Vector3d vector)

Updates plane inspection feature normal vector based on selected vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
vectorNew normal
void NXOpen::CAM::InspectionPlaneFeatureBuilder::UpdateParams ( )

Updates plane inspection feature characteristic parameters based on selected geometry
Created in NX7.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.