Represents the builder for the CMM Inspection sub-operation Scan Helix. More...

Inheritance diagram for NXOpen::CAM::InspectionScanHelixBuilder:

Public Member Functions
double	DepthDistance ()
	Returns the depth distance Created in NX9.0.0.

NXOpen::CAM::InspectionMoveBuilder::DepthMethodTypes	DepthMethod ()
	Returns the depth method Created in NX9.0.0.

NXOpen::CAM::InheritableDoubleBuilder *	EndDistance ()
	Returns the End Distance of the Scan Helix Created in NX8.5.0.

NXOpen::CAM::InheritableDoubleBuilder *	EndPercentage ()
	Returns the End Percentage of the Scan Helix Created in NX8.5.0.

NXOpen::CAM::InheritableDoubleBuilder *	Pitch ()
	Returns the pitch of the Scan Helix Created in NX8.5.0.

bool	Reversedirection ()
	Returns the Reverse Direction flag on the Helix Created in NX8.5.0.

NXOpen::CAM::InheritableDoubleBuilder *	Revolutions ()
	Returns the revolutions of the Scan Helix Created in NX8.5.0.

NXOpen::CAM::InspectionMethodBuilder::ScanModeTypes	ScanModeType ()
	Returns the 3,5 axis mode type Created in NX8.5.0.

void	SetDepthDistance (double distance)
	Sets the depth distance Created in NX9.0.0.

void	SetDepthMethod (NXOpen::CAM::InspectionMoveBuilder::DepthMethodTypes method)
	Sets the depth method Created in NX9.0.0.

void	SetReversedirection (bool reversedir)
	Sets the Reverse Direction flag on the Helix Created in NX8.5.0.

void	SetScanModeType (NXOpen::CAM::InspectionMethodBuilder::ScanModeTypes modeType)
	Sets the 3,5 axis mode type Created in NX8.5.0.

void	SetStartEndMode (NXOpen::CAM::InspectionMethodBuilder::UVModeTypes startEndMode)
	Sets the start/end mode Created in NX8.5.0.

void	SetTurnDirection (NXOpen::CAM::InspectionMethodBuilder::ScanHelixTurnDirectionTypes turnDirection)
	Sets the turn direction type Created in NX8.5.0.

void	SetTurnType (NXOpen::CAM::InspectionMethodBuilder::ScanHelixTurnTypes turnType)
	Sets the turn type Created in NX8.5.0.

NXOpen::CAM::InheritableDoubleBuilder *	StartDistance ()
	Returns the Start Distance of the Scan Helix Created in NX8.5.0.

NXOpen::CAM::InspectionMethodBuilder::UVModeTypes	StartEndMode ()
	Returns the start/end mode Created in NX8.5.0.

NXOpen::CAM::InheritableDoubleBuilder *	StartPercentage ()
	Returns the Start Percentage of the Scan Helix Created in NX8.5.0.

NXOpen::CAM::InheritableDoubleBuilder *	Sweep ()
	Returns the sweep of the Scan Helix Created in NX8.5.0.

NXOpen::CAM::InspectionMethodBuilder::ScanHelixTurnDirectionTypes	TurnDirection ()
	Returns the turn direction type Created in NX8.5.0.

NXOpen::CAM::InspectionMethodBuilder::ScanHelixTurnTypes	TurnType ()
	Returns the turn type Created in NX8.5.0.

Public Member Functions inherited from NXOpen::CAM::InspectionMoveBuilder
double	AngleA ()
	Returns the A angle for an indexable head Created in NX7.0.0.

double	AngleB ()
	Returns the B angle for an indexable head Created in NX7.0.0.

double	ApproachDistance ()
	Returns the approach distance Created in NX7.0.0.

NXOpen::CAM::MoveBuilder::Motion	MotionType ()
	Returns the motion type Created in NX7.0.0.

double	RetractDistance ()
	Returns the retract distance Created in NX7.0.0.

NXString	SensorOpName ()
	Returns the inspection sensor operation name Created in NX7.5.1.

NXOpen::CAM::InspectionMoveBuilder::SensorStrategyTypes	SensorStrategy ()
	Returns the sensor selection strategy Created in NX7.5.1.

NXOpen::CAM::InspectionSensorStrategyBuilder *	SensorStrategyBuilder ()
	Returns the Sensor Strategy Enum Builder Created in NX9.0.0.

void	SetAngleA (double angle)
	Sets the A angle for an indexable head Created in NX7.0.0.

void	SetAngleB (double angle)
	Sets the B angle for an indexable head Created in NX7.0.0.

void	SetApproachDistance (double distance)
	Sets the approach distance Created in NX7.0.0.

void	SetMotionType (NXOpen::CAM::MoveBuilder::Motion motionType)
	Sets the motion type Created in NX7.0.0.

void	SetParent (NXOpen::CAM::CAMObject *parent)
	Set parent Created in NX7.0.0.

void	SetProbeAngles ()
	Set default values for probe angles based on feature type.

void	SetRetractDistance (double distance)
	Sets the retract distance Created in NX7.0.0.

void	SetSensorOpName (const NXString &sensorOpName)
	Sets the inspection sensor operation name Created in NX7.5.1.

void	SetSensorOpName (const char *sensorOpName)
	Sets the inspection sensor operation name Created in NX7.5.1.

void	SetSensorStrategy (NXOpen::CAM::InspectionMoveBuilder::SensorStrategyTypes sensorStrategy)
	Sets the sensor selection strategy Created in NX7.5.1.

void	SetSibling (NXOpen::CAM::CAMObject *sibling)
	Set sibling Created in NX7.0.0.

void	SetTipAngleMode (NXOpen::CAM::InspectionMoveBuilder::TipAngleTypes tipAngleMode)
	Sets the tip angle selection mode Created in NX7.0.0.

void	SetTipMode (NXOpen::CAM::InspectionMoveBuilder::TipModeTypes tipMode)
	Sets the probe tip selection mode Created in NX7.0.0.

void	SetTipNumber (int tipNumber)
	Sets the probe tip number Created in NX7.0.0.

NXOpen::CAM::InspectionMoveBuilder::TipAngleTypes	TipAngleMode ()
	Returns the tip angle selection mode Created in NX7.0.0.

NXOpen::CAM::InspectionMoveBuilder::TipModeTypes	TipMode ()
	Returns the probe tip selection mode Created in NX7.0.0.

int	TipNumber ()
	Returns the probe tip number Created in NX7.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Additional Inherited Members
Public Types inherited from NXOpen::CAM::InspectionMoveBuilder
enum	DepthMethodTypes { DepthMethodTypesAuto = -1, DepthMethodTypesDistance, DepthMethodTypesFromFeatureNominal, DepthMethodTypesFromFeatureActual, DepthMethodTypesFromDatum }
	the depth method 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...

Detailed Description

Represents the builder for the CMM Inspection sub-operation Scan Helix.

To create a new instance of this class, use CAM::InspectionMoveCollection::CreateInspectionScanHelixBuilder

Created in NX8.5.0.

Member Function Documentation

double NXOpen::CAM::InspectionScanHelixBuilder::DepthDistance ( )

Returns the depth distance
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::InspectionMoveBuilder::DepthMethodTypes NXOpen::CAM::InspectionScanHelixBuilder::DepthMethod ( )

Returns the depth method
Created in NX9.0.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionScanHelixBuilder::EndDistance ( )

Returns the End Distance of the Scan Helix
Created in NX8.5.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionScanHelixBuilder::EndPercentage ( )

Returns the End Percentage of the Scan Helix
Created in NX8.5.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionScanHelixBuilder::Pitch ( )

Returns the pitch of the Scan Helix
Created in NX8.5.0.

License requirements : None

bool NXOpen::CAM::InspectionScanHelixBuilder::Reversedirection ( )

Returns the Reverse Direction flag on the Helix
Created in NX8.5.0.

License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionScanHelixBuilder::Revolutions ( )

Returns the revolutions of the Scan Helix
Created in NX8.5.0.

License requirements : None

NXOpen::CAM::InspectionMethodBuilder::ScanModeTypes NXOpen::CAM::InspectionScanHelixBuilder::ScanModeType ( )

Returns the 3,5 axis mode type
Created in NX8.5.0.

License requirements : None

void NXOpen::CAM::InspectionScanHelixBuilder::SetDepthDistance ( double distance )

Sets the depth distance
Created in NX9.0.0.