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

Represents the Probe Calibrate Sphere Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateProbeCalibrateSphereMoveBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::CAM::ProbeCalibrateSphereMoveBuilder:
NXOpen::CAM::MoveBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Geometry { GeometrySphere, 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, MotionLastCut, MotionCrossover
}
 the motion Type More...
 

Public Member Functions

double Diameter ()
 Returns the diameter defining the sphere to probe
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Geometry GeometryType ()
 Returns the type of geometry
Created in NX5.0.0. More...
 
NXOpen::PointPoint ()
 Returns the point defining the sphere to probe
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeProtectedParametersBuilderProbeProtectedParameters ()
 Returns the probe protected parameters builder
Created in NX5.0.0. More...
 
void SetDiameter (double diameter)
 Sets the diameter defining the sphere to probe
Created in NX5.0.0. More...
 
void SetGeometryType (NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Geometry geomType)
 Sets the type of geometry
Created in NX5.0.0. More...
 
void SetPoint (NXOpen::Point *point)
 Sets the point defining the sphere to probe
Created in NX5.0.0. More...
 
void SetSphere (NXOpen::NXObject *sphere)
 Sets the sphere to probe
Created in NX5.0.0. More...
 
void SetToolOffset (int toolOffset)
 Sets the tool offset to update
Created in NX5.0.0. More...
 
NXOpen::NXObjectSphere ()
 Returns the sphere to probe
Created in NX5.0.0. More...
 
int ToolOffset ()
 Returns the tool offset to update
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::MoveBuilder
double FeedRate ()
 Returns the feed rate
Created in NX5.0.0. More...
 
NXOpen::CAM::MoveBuilder::Feed FeedType ()
 Returns the feed type
Created in NX5.0.0. More...
 
NXOpen::CAM::FeedRateUnit FeedUnit ()
 Returns the feed unit
Created in NX7.5.0. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (const NXString &parameterName)
 Returns the custom parameter with the given name. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (const char *parameterName)
 Returns the custom parameter with the given name. More...
 
NXOpen::CAM::UdeParameterGetUserParameter (int index)
 Returns the parameter at the input index. More...
 
NXOpen::CAM::MoveBuilder::Motion MotionType ()
 Returns the motion type
Created in NX5.0.0. More...
 
int NumberOfUserParameters ()
 Returns the number of user parameters
Created in NX8.0.0. More...
 
bool ProtectedMove ()
 Returns the protected move status
Created in NX5.0.0. More...
 
void SetFeedRate (double feedRate)
 Sets the feed rate
Created in NX5.0.0. More...
 
void SetFeedType (NXOpen::CAM::MoveBuilder::Feed feedType)
 Sets the feed type
Created in NX5.0.0. More...
 
void SetFeedUnit (NXOpen::CAM::FeedRateUnit unit)
 Sets the feed unit
Created in NX7.5.0. More...
 
void SetMotionType (NXOpen::CAM::MoveBuilder::Motion motionType)
 Sets the motion type
Created in NX5.0.0. More...
 
void SetParent (NXOpen::CAM::CAMObject *parent)
 Set parent
Created in NX5.0.0. More...
 
void SetProtectedMove (bool protectedMove)
 Sets the protected move status
Created in NX5.0.0. More...
 
void SetSibling (NXOpen::CAM::CAMObject *sibling)
 Set sibling
Created in NX5.0.0. More...
 
void SetSubopLabel (const NXString &subopLabel)
 Sets the subop label
Created in NX8.5.1. More...
 
void SetSubopLabel (const char *subopLabel)
 Sets the subop label
Created in NX8.5.1. More...
 
NXString SubopLabel ()
 Returns the subop label
Created in NX8.5.1. 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 the Probe Calibrate Sphere Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateProbeCalibrateSphereMoveBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the geometry types

Enumerator
GeometrySphere 

Sphere.

GeometryPoint 

Point.

Member Function Documentation

double NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Diameter ( )

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



License requirements : None

NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Geometry NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::GeometryType ( )

Returns the type of geometry
Created in NX5.0.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Point ( )

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



License requirements : None

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

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



License requirements : None

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

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



License requirements : cam_base ("CAM BASE")

Parameters
diameterdiameter
void NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::SetGeometryType ( NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Geometry  geomType)

Sets the type of geometry
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
geomTypegeomtype
void NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::SetPoint ( NXOpen::Point point)

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



License requirements : cam_base ("CAM BASE")

Parameters
pointpoint
void NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::SetSphere ( NXOpen::NXObject sphere)

Sets the sphere to probe
Created in NX5.0.0.



License requirements : cam_base ("CAM BASE")

Parameters
spheresphere
void NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::SetToolOffset ( int  toolOffset)

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



License requirements : cam_base ("CAM BASE")

Parameters
toolOffsettool offset
NXOpen::NXObject* NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::Sphere ( )

Returns the sphere to probe
Created in NX5.0.0.



License requirements : None

int NXOpen::CAM::ProbeCalibrateSphereMoveBuilder::ToolOffset ( )

Returns the tool offset to update
Created in NX5.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.