NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAM::ProbeCalibrateStylusMoveBuilder Class Reference

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:
NXOpen::CAM::MoveBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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 Member Functions

NXOpen::NXObjectArcVector ()
 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::NXObjectCylinder ()
 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::PointPoint ()
 Returns the point defining the cylinder to probe
Created in NX5.0.0.
NXOpen::CAM::ProbeProtectedParametersBuilderProbeProtectedParameters ()
 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.

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

the stylus calibration types

Enumerator:
CalibrateStylusTypeOffsets 

Stylus offsets.

CalibrateStylusTypeRadius 

Stylus ball radius.

CalibrateStylusTypeVectorRadius 

Stylus vector ball radius.

the depth types

Enumerator:
DepthMidpoint 

Midpoint of cylinder.

DepthSpecify 

Specify distance.

the geometry types

Enumerator:
GeometryCylinder 

Cylinder.

GeometryPoint 

Point.


Member Function Documentation

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



License requirements : None

Returns the calibration depth
Created in NX5.0.0.



License requirements : None

Returns the calibration type
Created in NX5.0.0.



License requirements : None

Returns the cylinder to probe
Created in NX5.0.0.



License requirements : None

Returns the depth type
Created in NX5.0.0.



License requirements : None

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



License requirements : None

Returns the geometry type
Created in NX5.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Parameters:
vectorvector

Sets the calibration depth
Created in NX5.0.0.



License requirements : None

Parameters:
calibrationDepthcalibration depth

Sets the calibration type
Created in NX5.0.0.



License requirements : None

Parameters:
calibTypecalibtype

Sets the cylinder to probe
Created in NX5.0.0.



License requirements : None

Parameters:
cylindercylinder

Sets the depth type
Created in NX5.0.0.



License requirements : None

Parameters:
depthTypedepthtype

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



License requirements : None

Parameters:
diameterdiameter

Sets the geometry type
Created in NX5.0.0.



License requirements : None

Parameters:
geomTypegeomtype

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



License requirements : None

Parameters:
newValuenewvalue

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



License requirements : None

Parameters:
pointpoint

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



License requirements : None

Parameters:
workOffsetwork offset

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.