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

Represents the Probe Inspect Surface Point Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateProbeInspectSurfacePointMoveBuilder

Created in NX5.0.0. More...

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

Public Types

enum  Direction { DirectionNormal, DirectionVector = 7 }
 the probing direction type More...
 
enum  Measurement { MeasurementAxis2, MeasurementAxis3 }
 the measurement type More...
 
enum  ToolAxis { ToolAxisNone, ToolAxisNormal, ToolAxisAutomatic }
 the probing tool axis type 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

NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Direction DirectionType ()
 Returns the direction type
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Measurement MeasurementType ()
 Returns the measurement (axis) type
Created in NX5.0.0. More...
 
NXOpen::PointPoint ()
 Returns the point to probe
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeControlParametersBuilderProbeControlParameters ()
 Returns the probe control parameters builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeProtectedParametersBuilderProbeProtectedParameters ()
 Returns the probe protected parameters builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeStockParametersBuilderProbeStockParameters ()
 Returns the probe stock parameters builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeToleranceParametersBuilderProbeToleranceParameters ()
 Returns the probe tolerance parameters builder
Created in NX5.0.0. More...
 
void SetDirectionType (NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Direction dirType)
 Sets the direction type
Created in NX5.0.0. More...
 
void SetMeasurementType (NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Measurement measType)
 Sets the measurement (axis) type
Created in NX5.0.0. More...
 
void SetPoint (NXOpen::Point *point)
 Sets the point to probe
Created in NX5.0.0. More...
 
void SetToolAxisType (NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ToolAxis axisType)
 Sets the probe axis type
Created in NX7.5.0. More...
 
void SetVector (NXOpen::NXObject *vector)
 Sets the vector to define probing direction
Created in NX5.0.0. More...
 
NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ToolAxis ToolAxisType ()
 Returns the probe axis type
Created in NX7.5.0. More...
 
NXOpen::NXObjectVector ()
 Returns the vector to define probing direction
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 Inspect Surface Point Move Builder
To create a new instance of this class, use NXOpen::CAM::MoveCollection::CreateProbeInspectSurfacePointMoveBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the probing direction type

Enumerator
DirectionNormal 

Inferred using surface normal.

DirectionVector 

Specify vector.

the measurement type

Enumerator
MeasurementAxis2 

2 Axis

MeasurementAxis3 

3 Axis

the probing tool axis type

Enumerator
ToolAxisNone 

Use the Previous Tool Axis.

ToolAxisNormal 

Inferred using surface normal.

ToolAxisAutomatic 

Tool Axis aligned with closest machine axis.

Member Function Documentation

NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Direction NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::DirectionType ( )

Returns the direction type
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Measurement NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::MeasurementType ( )

Returns the measurement (axis) type
Created in NX5.0.0.



License requirements : None

NXOpen::Point* NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Point ( )

Returns the point to probe
Created in NX5.0.0.



License requirements : None

NXOpen::CAM::ProbeControlParametersBuilder* NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ProbeControlParameters ( )

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



License requirements : None

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

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



License requirements : None

NXOpen::CAM::ProbeStockParametersBuilder* NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ProbeStockParameters ( )

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



License requirements : None

NXOpen::CAM::ProbeToleranceParametersBuilder* NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ProbeToleranceParameters ( )

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



License requirements : None

void NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::SetDirectionType ( NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Direction  dirType)

Sets the direction type
Created in NX5.0.0.



License requirements : None

Parameters
dirTypedirtype
void NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::SetMeasurementType ( NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Measurement  measType)

Sets the measurement (axis) type
Created in NX5.0.0.



License requirements : None

Parameters
measTypemeastype
void NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::SetPoint ( NXOpen::Point point)

Sets the point to probe
Created in NX5.0.0.



License requirements : None

Parameters
pointpoint
void NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::SetToolAxisType ( NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ToolAxis  axisType)

Sets the probe axis type
Created in NX7.5.0.



License requirements : None

Parameters
axisTypeaxistype
void NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::SetVector ( NXOpen::NXObject vector)

Sets the vector to define probing direction
Created in NX5.0.0.



License requirements : None

Parameters
vectorvector
NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ToolAxis NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::ToolAxisType ( )

Returns the probe axis type
Created in NX7.5.0.



License requirements : None

NXOpen::NXObject* NXOpen::CAM::ProbeInspectSurfacePointMoveBuilder::Vector ( )

Returns the vector to define probing direction
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.