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

Represents CMM Inspection Move Builder
This cannot be instantiated

Created in NX7.0.0. More...

Inheritance diagram for NXOpen::CAM::InspectionMoveBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAM::InspectionDeltaMoveBuilder NXOpen::CAM::InspectionLinear5axisMoveToPointBuilder NXOpen::CAM::InspectionLinearMoveToPointBuilder NXOpen::CAM::InspectionMeasurePointBuilder NXOpen::CAM::InspectionPolarGridBuilder NXOpen::CAM::InspectionScanArcBuilder NXOpen::CAM::InspectionScanCurve5AxisBuilder NXOpen::CAM::InspectionScanCurveBuilder NXOpen::CAM::InspectionScanHelixBuilder NXOpen::CAM::InspectionScanLineBuilder NXOpen::CAM::InspectionUVGridBuilder

Public Types

enum  DepthMethodTypes {
  DepthMethodTypesAuto = -1, DepthMethodTypesDistance, DepthMethodTypesFromFeatureNominal, DepthMethodTypesFromFeatureActual,
  DepthMethodTypesFromDatum
}
 the depth method More...
 
enum  ProbeTipTypes { ProbeTipTypesAny = -1, ProbeTipTypesSphere, ProbeTipTypesCylinder, ProbeTipTypesDisk }
 the preferred probe tip type More...
 
enum  SensorStrategyTypes { SensorStrategyTypesCreateAsNeeded, SensorStrategyTypesUseExisting }
 the sensor selection strategy More...
 
enum  TipAngleTypes { TipAngleTypesAuto, TipAngleTypesSpecify, TipAngleTypesExisting }
 the tip angle selection mode More...
 
enum  TipModeTypes { TipModeTypesAuto, TipModeTypesSpecify, TipModeTypesExisting }
 the tip selection mode More...
 

Public Member Functions

double AngleA ()
 Returns the A angle for an indexable head
Created in NX7.0.0. More...
 
double AngleB ()
 Returns the B angle for an indexable head
Created in NX7.0.0. More...
 
double ApproachDistance ()
 Returns the approach distance
Created in NX7.0.0. More...
 
void LockMove (bool lock)
 Set lock to prevent move parameters from being changed programmatically. More...
 
NXOpen::CAM::MoveBuilder::Motion MotionType ()
 Returns the motion type
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes ProbeTipType ()
 Returns the preferred probe tip type
Created in NX9.0.1. More...
 
NXOpen::CAM::InspectionProbeTipTypeBuilderProbeTipTypeBuilder ()
 Returns the Probe Tip Type Builder
Created in NX9.0.1. More...
 
double RetractDistance ()
 Returns the retract distance
Created in NX7.0.0. More...
 
NXString SensorOpName ()
 Returns the inspection sensor operation name
Created in NX7.5.1. More...
 
NXOpen::CAM::InspectionMoveBuilder::SensorStrategyTypes SensorStrategy ()
 Returns the sensor selection strategy
Created in NX7.5.1. More...
 
NXOpen::CAM::InspectionSensorStrategyBuilderSensorStrategyBuilder ()
 Returns the Sensor Strategy Enum Builder
Created in NX9.0.0. More...
 
void SetAngleA (double angle)
 Sets the A angle for an indexable head
Created in NX7.0.0. More...
 
void SetAngleB (double angle)
 Sets the B angle for an indexable head
Created in NX7.0.0. More...
 
void SetApproachDistance (double distance)
 Sets the approach distance
Created in NX7.0.0. More...
 
void SetMotionType (NXOpen::CAM::MoveBuilder::Motion motionType)
 Sets the motion type
Created in NX7.0.0. More...
 
void SetParent (NXOpen::CAM::CAMObject *parent)
 Set parent
Created in NX7.0.0. More...
 
void SetProbeAngles ()
 Set default values for probe angles based on feature type. More...
 
void SetProbeTip ()
 Set default probe tip based on preferred tip type and probe angles. More...
 
void SetProbeTipType (NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes tipType)
 Sets the preferred probe tip type
Created in NX9.0.1. More...
 
void SetRetractDistance (double distance)
 Sets the retract distance
Created in NX7.0.0. More...
 
void SetSensorOpName (const NXString &sensorOpName)
 Sets the inspection sensor operation name
Created in NX7.5.1. More...
 
void SetSensorOpName (const char *sensorOpName)
 Sets the inspection sensor operation name
Created in NX7.5.1. More...
 
void SetSensorStrategy (NXOpen::CAM::InspectionMoveBuilder::SensorStrategyTypes sensorStrategy)
 Sets the sensor selection strategy
Created in NX7.5.1. More...
 
void SetSibling (NXOpen::CAM::CAMObject *sibling)
 Set sibling
Created in NX7.0.0. More...
 
void SetTipAngleMode (NXOpen::CAM::InspectionMoveBuilder::TipAngleTypes tipAngleMode)
 Sets the tip angle selection mode
Created in NX7.0.0. More...
 
void SetTipMode (NXOpen::CAM::InspectionMoveBuilder::TipModeTypes tipMode)
 Sets the probe tip selection mode
Created in NX7.0.0. More...
 
void SetTipNumber (int tipNumber)
 Sets the probe tip number
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionMoveBuilder::TipAngleTypes TipAngleMode ()
 Returns the tip angle selection mode
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionMoveBuilder::TipModeTypes TipMode ()
 Returns the probe tip selection mode
Created in NX7.0.0. More...
 
int TipNumber ()
 Returns the probe tip number
Created in NX7.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 CMM Inspection Move Builder
This cannot be instantiated

Created in NX7.0.0.


Member Enumeration Documentation

the depth method

Enumerator
DepthMethodTypesAuto 

Auto specify.

DepthMethodTypesDistance 

Distance only.

DepthMethodTypesFromFeatureNominal 

Distance from feature nominal.

DepthMethodTypesFromFeatureActual 

Distance from feature actual.

DepthMethodTypesFromDatum 

Distance from datum.

the preferred probe tip type

Enumerator
ProbeTipTypesAny 

Any tip type.

ProbeTipTypesSphere 

Sphere tip.

ProbeTipTypesCylinder 

Cylinder tip.

ProbeTipTypesDisk 

Disk tip.

the sensor selection strategy

Enumerator
SensorStrategyTypesCreateAsNeeded 

Create as needed.

SensorStrategyTypesUseExisting 

Use existing only.

the tip angle selection mode

Enumerator
TipAngleTypesAuto 

Auto specify.

TipAngleTypesSpecify 

Manual specify.

TipAngleTypesExisting 

From existing sensor.

the tip selection mode

Enumerator
TipModeTypesAuto 

Auto specify.

TipModeTypesSpecify 

Manual specify.

TipModeTypesExisting 

From existing sensor.

Member Function Documentation

double NXOpen::CAM::InspectionMoveBuilder::AngleA ( )

Returns the A angle for an indexable head
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionMoveBuilder::AngleB ( )

Returns the B angle for an indexable head
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionMoveBuilder::ApproachDistance ( )

Returns the approach distance
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionMoveBuilder::LockMove ( bool  lock)

Set lock to prevent move parameters from being changed programmatically.


Created in NX11.0.2.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
locklock
NXOpen::CAM::MoveBuilder::Motion NXOpen::CAM::InspectionMoveBuilder::MotionType ( )

Returns the motion type
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes NXOpen::CAM::InspectionMoveBuilder::ProbeTipType ( )

Returns the preferred probe tip type
Created in NX9.0.1.



License requirements : None

NXOpen::CAM::InspectionProbeTipTypeBuilder* NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypeBuilder ( )

Returns the Probe Tip Type Builder
Created in NX9.0.1.



License requirements : None

double NXOpen::CAM::InspectionMoveBuilder::RetractDistance ( )

Returns the retract distance
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionMoveBuilder::SensorOpName ( )

Returns the inspection sensor operation name
Created in NX7.5.1.



License requirements : None

NXOpen::CAM::InspectionMoveBuilder::SensorStrategyTypes NXOpen::CAM::InspectionMoveBuilder::SensorStrategy ( )

Returns the sensor selection strategy
Created in NX7.5.1.



License requirements : None

NXOpen::CAM::InspectionSensorStrategyBuilder* NXOpen::CAM::InspectionMoveBuilder::SensorStrategyBuilder ( )

Returns the Sensor Strategy Enum Builder
Created in NX9.0.0.



License requirements : None

void NXOpen::CAM::InspectionMoveBuilder::SetAngleA ( double  angle)

Sets the A angle for an indexable head
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleangle
void NXOpen::CAM::InspectionMoveBuilder::SetAngleB ( double  angle)

Sets the B angle for an indexable head
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleangle
void NXOpen::CAM::InspectionMoveBuilder::SetApproachDistance ( double  distance)

Sets the approach distance
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
distancedistance
void NXOpen::CAM::InspectionMoveBuilder::SetMotionType ( NXOpen::CAM::MoveBuilder::Motion  motionType)

Sets the motion type
Created in NX7.0.0.



License requirements : None

Parameters
motionTypemotion type
void NXOpen::CAM::InspectionMoveBuilder::SetParent ( NXOpen::CAM::CAMObject parent)

Set parent
Created in NX7.0.0.



License requirements : None

Parameters
parentthe parent object
void NXOpen::CAM::InspectionMoveBuilder::SetProbeAngles ( )

Set default values for probe angles based on feature type.


Created in NX7.5.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionMoveBuilder::SetProbeTip ( )

Set default probe tip based on preferred tip type and probe angles.


Created in NX9.0.1.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionMoveBuilder::SetProbeTipType ( NXOpen::CAM::InspectionMoveBuilder::ProbeTipTypes  tipType)

Sets the preferred probe tip type
Created in NX9.0.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipTypetiptype
void NXOpen::CAM::InspectionMoveBuilder::SetRetractDistance ( double  distance)

Sets the retract distance
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
distancedistance
void NXOpen::CAM::InspectionMoveBuilder::SetSensorOpName ( const NXString sensorOpName)

Sets the inspection sensor operation name
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
sensorOpNamesensoropname
void NXOpen::CAM::InspectionMoveBuilder::SetSensorOpName ( const char *  sensorOpName)

Sets the inspection sensor operation name
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
sensorOpNamesensoropname
void NXOpen::CAM::InspectionMoveBuilder::SetSensorStrategy ( NXOpen::CAM::InspectionMoveBuilder::SensorStrategyTypes  sensorStrategy)

Sets the sensor selection strategy
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
sensorStrategysensorstrategy
void NXOpen::CAM::InspectionMoveBuilder::SetSibling ( NXOpen::CAM::CAMObject sibling)

Set sibling
Created in NX7.0.0.



License requirements : None

Parameters
siblingthe sibling object
void NXOpen::CAM::InspectionMoveBuilder::SetTipAngleMode ( NXOpen::CAM::InspectionMoveBuilder::TipAngleTypes  tipAngleMode)

Sets the tip angle selection mode
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipAngleModetipanglemode
void NXOpen::CAM::InspectionMoveBuilder::SetTipMode ( NXOpen::CAM::InspectionMoveBuilder::TipModeTypes  tipMode)

Sets the probe tip selection mode
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipModetipmode
void NXOpen::CAM::InspectionMoveBuilder::SetTipNumber ( int  tipNumber)

Sets the probe tip number
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipNumbertipnumber
NXOpen::CAM::InspectionMoveBuilder::TipAngleTypes NXOpen::CAM::InspectionMoveBuilder::TipAngleMode ( )

Returns the tip angle selection mode
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionMoveBuilder::TipModeTypes NXOpen::CAM::InspectionMoveBuilder::TipMode ( )

Returns the probe tip selection mode
Created in NX7.0.0.



License requirements : None

int NXOpen::CAM::InspectionMoveBuilder::TipNumber ( )

Returns the probe tip number
Created in NX7.0.0.



License requirements : None


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