Represents the Probe Calibrate Stylus Move Builder
To create a new instance of this class, use CAM::MoveCollection::CreateProbeCalibrateStylusMoveBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::ProbeCalibrateStylusMoveBuilder:

Public Types
enum	CalibrateStylusType { CalibrateStylusTypeOffsets, CalibrateStylusTypeRadius, CalibrateStylusTypeVectorRadius }
	the stylus calibration types More...

enum	Depth { DepthMidpoint, DepthSpecify }
	the depth types More...

enum	Geometry { GeometryCylinder, GeometryPoint }
	the geometry types More...

Public Types inherited from NXOpen::CAM::MoveBuilder
enum	Feed { FeedMotion, FeedCustom }
	the feed Type More...

enum	Motion { MotionRapid = 1, MotionEngage, MotionCut, MotionStepover, MotionRetract, MotionApproach, MotionTraversal, MotionDeparture, MotionReturn, MotionFirstCut }
	the motion Type More...

Public Member Functions
NXOpen::NXObject *	ArcVector ()
	Returns the arc vector defining the cylinder to probe Created in NX5.0.0.

double	CalibrationDepth ()
	Returns the calibration depth Created in NX5.0.0.

NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrateStylusType	CalibrationType ()
	Returns the calibration type Created in NX5.0.0.

NXOpen::NXObject *	Cylinder ()
	Returns the cylinder to probe Created in NX5.0.0.

NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Depth	DepthType ()
	Returns the depth type Created in NX5.0.0.

double	Diameter ()
	Returns the diameter defining the cylinder to probe Created in NX5.0.0.

NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Geometry	GeometryType ()
	Returns the geometry type Created in NX5.0.0.

bool	OutputWorkOffset ()
	Returns the option to output the work offset to update Created in NX5.0.0.

NXOpen::Point *	Point ()
	Returns the point defining the cylinder to probe Created in NX5.0.0.

NXOpen::CAM::ProbeProtectedParametersBuilder *	ProbeProtectedParameters ()
	Returns the probe protected parameters builder Created in NX5.0.0.

void	SetArcVector (NXOpen::NXObject *vector)
	Sets the arc vector defining the cylinder to probe Created in NX5.0.0.

void	SetCalibrationDepth (double calibrationDepth)
	Sets the calibration depth Created in NX5.0.0.

void	SetCalibrationType (NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrateStylusType calibType)
	Sets the calibration type Created in NX5.0.0.

void	SetCylinder (NXOpen::NXObject *cylinder)
	Sets the cylinder to probe Created in NX5.0.0.

void	SetDepthType (NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Depth depthType)
	Sets the depth type Created in NX5.0.0.

void	SetDiameter (double diameter)
	Sets the diameter defining the cylinder to probe Created in NX5.0.0.

void	SetGeometryType (NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Geometry geomType)
	Sets the geometry type Created in NX5.0.0.

void	SetOutputWorkOffset (bool newValue)
	Sets the option to output the work offset to update Created in NX5.0.0.

void	SetPoint (NXOpen::Point *point)
	Sets the point defining the cylinder to probe Created in NX5.0.0.

void	SetWorkOffset (int workOffset)
	Sets the work offset to update Created in NX5.0.0.

int	WorkOffset ()
	Returns the work offset to update Created in NX5.0.0.

Public Member Functions inherited from NXOpen::CAM::MoveBuilder
double	FeedRate ()
	Returns the feed rate Created in NX5.0.0.

NXOpen::CAM::MoveBuilder::Feed	FeedType ()
	Returns the feed type Created in NX5.0.0.

NXOpen::CAM::FeedRateUnit	FeedUnit ()
	Returns the feed unit Created in NX7.5.0.

NXOpen::CAM::UdeParameter *	GetUserParameter (const NXString &parameterName)
	Returns the custom parameter with the given name.

NXOpen::CAM::UdeParameter *	GetUserParameter (const char *parameterName)
	Returns the custom parameter with the given name.

NXOpen::CAM::UdeParameter *	GetUserParameter (int index)
	Returns the parameter at the input index.

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

int	NumberOfUserParameters ()
	Returns the number of user parameters Created in NX8.0.0.

bool	ProtectedMove ()
	Returns the protected move status Created in NX5.0.0.

void	SetFeedRate (double feedRate)
	Sets the feed rate Created in NX5.0.0.

void	SetFeedType (NXOpen::CAM::MoveBuilder::Feed feedType)
	Sets the feed type Created in NX5.0.0.

void	SetFeedUnit (NXOpen::CAM::FeedRateUnit unit)
	Sets the feed unit Created in NX7.5.0.

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

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

void	SetProtectedMove (bool protectedMove)
	Sets the protected move status Created in NX5.0.0.

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

void	SetSubopLabel (const NXString &subopLabel)
	Sets the subop label Created in NX8.5.1.

void	SetSubopLabel (const char *subopLabel)
	Sets the subop label Created in NX8.5.1.

NXString	SubopLabel ()
	Returns the subop label Created in NX8.5.1.

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.

Detailed Description

Represents the Probe Calibrate Stylus Move Builder
To create a new instance of this class, use CAM::MoveCollection::CreateProbeCalibrateStylusMoveBuilder

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrateStylusType

the stylus calibration types

Enumerator:

CalibrateStylusTypeOffsets	Stylus offsets.
CalibrateStylusTypeRadius	Stylus ball radius.
CalibrateStylusTypeVectorRadius	Stylus vector ball radius.

enum NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Depth

the depth types

Enumerator:

DepthMidpoint	Midpoint of cylinder.
DepthSpecify	Specify distance.

enum NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Geometry

the geometry types

Enumerator:

GeometryCylinder	Cylinder.
GeometryPoint	Point.

Member Function Documentation

NXOpen::NXObject* NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::ArcVector ( )

Returns the arc vector defining the cylinder to probe
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrationDepth ( )

Returns the calibration depth
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrateStylusType NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrationType ( )

Returns the calibration type
Created in NX5.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Cylinder ( )

Returns the cylinder to probe
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Depth NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::DepthType ( )

Returns the depth type
Created in NX5.0.0.

License requirements : None

double NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Diameter ( )

Returns the diameter defining the cylinder to probe
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Geometry NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::GeometryType ( )

Returns the geometry type
Created in NX5.0.0.

License requirements : None

bool NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::OutputWorkOffset ( )

Returns the option to output the work offset to update
Created in NX5.0.0.

License requirements : None

NXOpen::Point* NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Point ( )

Returns the point defining the cylinder to probe
Created in NX5.0.0.

License requirements : None

NXOpen::CAM::ProbeProtectedParametersBuilder* NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::ProbeProtectedParameters ( )

Returns the probe protected parameters builder
Created in NX5.0.0.

License requirements : None

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetArcVector ( NXOpen::NXObject * vector )

Sets the arc vector defining the cylinder to probe
Created in NX5.0.0.

License requirements : None

Parameters

vector vector

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetCalibrationDepth ( double calibrationDepth )

Sets the calibration depth
Created in NX5.0.0.

License requirements : None

Parameters

calibrationDepth calibration depth

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetCalibrationType ( NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::CalibrateStylusType calibType )

Sets the calibration type
Created in NX5.0.0.

License requirements : None

Parameters

calibType calibtype

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetCylinder ( NXOpen::NXObject * cylinder )

Sets the cylinder to probe
Created in NX5.0.0.

License requirements : None

Parameters

cylinder cylinder

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetDepthType ( NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Depth depthType )

Sets the depth type
Created in NX5.0.0.

License requirements : None

Parameters

depthType depthtype

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetDiameter ( double diameter )

Sets the diameter defining the cylinder to probe
Created in NX5.0.0.

License requirements : None

Parameters

diameter diameter

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetGeometryType ( NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::Geometry geomType )

Sets the geometry type
Created in NX5.0.0.

License requirements : None

Parameters

geomType geomtype

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetOutputWorkOffset ( bool newValue )

Sets the option to output the work offset to update
Created in NX5.0.0.

License requirements : None

Parameters

newValue newvalue

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetPoint ( NXOpen::Point * point )

Sets the point defining the cylinder to probe
Created in NX5.0.0.

License requirements : None

Parameters

point point

void NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::SetWorkOffset ( int workOffset )

Sets the work offset to update
Created in NX5.0.0.

License requirements : None

Parameters

workOffset work offset

int NXOpen::CAM::ProbeCalibrateStylusMoveBuilder::WorkOffset ( )

Returns the work offset to update
Created in NX5.0.0.

License requirements : None

The documentation for this class was generated from the following file:

CAM_ProbeCalibrateStylusMoveBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation