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

Represents the builder for a CMM Inspection Sensor. More...

Inheritance diagram for NXOpen::CAM::InspectionSensorBuilder:
NXOpen::CAM::OperationBuilder NXOpen::CAM::ParamBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SensorTipLocationTypes { SensorTipLocationTypesCartesian, SensorTipLocationTypesPolar, SensorTipLocationTypesVector }
 the sensor tip location method More...
 
enum  SensorTipTypes { SensorTipTypesSphere, SensorTipTypesCylinder, SensorTipTypesDisk }
 the sensor tip type More...
 
enum  SensorTypes { SensorTypesFixed, SensorTypesIndex }
 the sensor type More...
 
- Public Types inherited from NXOpen::CAM::OperationBuilder
enum  HoleAxisTypes { HoleAxisTypesVector, HoleAxisTypesRule, HoleAxisTypesRuleIfNoVector }
 Available types for Hole Axis Type in feature milling and hole making. More...
 
enum  HoleDepthTypes { HoleDepthTypesPoint, HoleDepthTypesRule }
 Available types for Hole Depth Type in feature milling and hole making. More...
 
enum  OptimizationBasedOnTypes { OptimizationBasedOnTypesDist, OptimizationBasedOnTypesOrient }
 Available types for optimization based on in operation. More...
 
enum  OptimizationDistanceTypes { OptimizationDistanceTypesDirect, OptimizationDistanceTypesTransition }
 Available types for optimization distance method in operation. More...
 
enum  OptimizationLevelTypes { OptimizationLevelTypesStandard, OptimizationLevelTypesAdvanced }
 Available types for optimization level in operation. More...
 
- Public Types inherited from NXOpen::CAM::ParamBuilder
enum  OptimizationTypes { OptimizationTypesNone, OptimizationTypesMinimizeTravel, OptimizationTypesBand }
 Available types for Optimization Method in operation. More...
 

Public Member Functions

double AngleA ()
 Returns the sensor tip location tilt angle component
Created in NX7.0.0. More...
 
double AngleB ()
 Returns the sensor tip location rotation angle component
Created in NX7.0.0. More...
 
std::vector< double > GetSensorTipIjk ()
 Get the sensor tip location vector coordinates. More...
 
std::vector< double > GetSensorTipXyz ()
 Get the sensor tip location cartesian coordinates. More...
 
NXString MasterOpLabel ()
 Returns the master sensor label
Created in NX7.0.0. More...
 
NXString SensorOpLabel ()
 Returns the sensor label
Created in NX7.0.0. More...
 
NXString SensorOpName ()
 Returns the inspection sensor operation name
Created in NX7.5.1. More...
 
double SensorTipDiameter ()
 Returns the sensor tip diameter
Created in NX7.0.0. More...
 
double SensorTipLength ()
 Returns the sensor tip length
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionSensorBuilder::SensorTipLocationTypes SensorTipLocation ()
 Returns the sensor tip location method
Created in NX7.0.0. More...
 
double SensorTipSize ()
 Returns the sensor tip size
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionSensorBuilder::SensorTipTypes SensorTipType ()
 Returns the sensor tip type
Created in NX7.0.0. More...
 
NXOpen::CAM::InspectionSensorBuilder::SensorTypes SensorType ()
 Returns the sensor type
Created in NX7.0.0. More...
 
void SetAngleA (double angle)
 Sets the sensor tip location tilt angle component
Created in NX7.0.0. More...
 
void SetAngleB (double angle)
 Sets the sensor tip location rotation angle component
Created in NX7.0.0. More...
 
void SetMasterOpLabel (const NXString &label)
 Sets the master sensor label
Created in NX7.0.0. More...
 
void SetMasterOpLabel (const char *label)
 Sets the master sensor label
Created in NX7.0.0. More...
 
void SetSensorOpLabel (const NXString &label)
 Sets the sensor label
Created in NX7.0.0. More...
 
void SetSensorOpLabel (const char *label)
 Sets the sensor label
Created in NX7.0.0. More...
 
void SetSensorOpName (const NXString &sensorOpName)
 Sets the inspection sensor operation name
Created in NX7.5.1. More...
 
void SetSensorOpName (const char *sensorOpName)
 Sets the inspection sensor operation name
Created in NX7.5.1. More...
 
void SetSensorTipDiameter (double diameter)
 Sets the sensor tip diameter
Created in NX7.0.0. More...
 
void SetSensorTipIjk (const std::vector< double > &ijk)
 Set the sensor tip location vector coordinates
Created in NX7.0.0. More...
 
void SetSensorTipLength (double length)
 Sets the sensor tip length
Created in NX7.0.0. More...
 
void SetSensorTipLocation (NXOpen::CAM::InspectionSensorBuilder::SensorTipLocationTypes type)
 Sets the sensor tip location method
Created in NX7.0.0. More...
 
void SetSensorTipSize (double size)
 Sets the sensor tip size
Created in NX7.0.0. More...
 
void SetSensorTipType (NXOpen::CAM::InspectionSensorBuilder::SensorTipTypes type)
 Sets the sensor tip type
Created in NX7.0.0. More...
 
void SetSensorTipXyz (const std::vector< double > &xyz)
 Set the sensor tip location cartesian coordinates
Created in NX7.0.0. More...
 
void SetSensorType (NXOpen::CAM::InspectionSensorBuilder::SensorTypes type)
 Sets the sensor type
Created in NX7.0.0. More...
 
void SetTipNumber (int tipNumber)
 Sets the probe tip number
Created in NX7.0.0. More...
 
void SetToolName (const NXString &toolName)
 Sets the inspection probe tool name
Created in NX7.5.1. More...
 
void SetToolName (const char *toolName)
 Sets the inspection probe tool name
Created in NX7.5.1. More...
 
int TipNumber ()
 Returns the probe tip number
Created in NX7.0.0. More...
 
NXString ToolName ()
 Returns the inspection probe tool name
Created in NX7.5.1. More...
 
- Public Member Functions inherited from NXOpen::CAM::OperationBuilder
NXString ChannelName ()
 Returns the channel's name
Created in NX7.5.0. More...
 
NXString Description ()
 Returns the description
Created in NX9.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderEndOfPath ()
 Returns the end event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetEndUdeSet ()
 Returns the end ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::GeometryCiBuilderGeometry ()
 Returns the geometry builder
Created in NX5.0.0. More...
 
std::vector< double > GetHoleAxisValues ()
 Get the Hole Axis values. More...
 
bool GougeChecking ()
 Returns the gouge checking flag
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleAxisTypes HoleAxisType ()
 Returns the Hole Axis Type
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderHoleDepth ()
 Returns the max depth distance builder
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::HoleDepthTypes HoleDepthType ()
 Returns the Hole Depth Type
Created in NX5.0.0. More...
 
NXOpen::CAM::LayoutCiBuilderLayoutAndLayer ()
 Returns the Layer and Layout
Created in NX9.0.1. More...
 
NXOpen::CAM::ArcOutputTypeCiBuilderMotionOutputBuilder ()
 Returns the motion output builder
Created in NX8.0.0. More...
 
NXOpen::CAM::NotesNotes ()
 Returns the notes builder
Created in NX9.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes OptimizationBasedOn ()
 Returns the optimization based on in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes OptimizationDistanceMethod ()
 Returns the optimization distance method in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationBuilder::OptimizationLevelTypes OptimizationLevel ()
 Returns the optimization level in operation
Created in NX5.0.0. More...
 
NXOpen::CAM::OperationDisplayOptionsBuilderPathDisplayOptions ()
 Returns the path display options builder
Created in NX6.0.0. More...
 
NXString PostToolPathExit ()
 Returns the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistance ()
 Returns the Retract Distance builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderRetractDistanceOnToolAxisChange ()
 Returns the Retract Distance on Tool Axis Change builder (inheritable double)
Created in NX5.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderSafeClearance ()
 Returns the safe clearance builder
Created in NX6.0.0. More...
 
bool SelectToolFlag ()
 Returns the user selected tool
Created in NX5.0.0. More...
 
void SetChannelName (const NXString &channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetChannelName (const char *channel)
 Sets the channel's name
Created in NX7.5.0. More...
 
void SetDescription (const NXString &description)
 Sets the description
Created in NX9.0.0. More...
 
void SetDescription (const char *description)
 Sets the description
Created in NX9.0.0. More...
 
void SetGougeChecking (bool gougeChecking)
 Sets the gouge checking flag
Created in NX9.0.0. More...
 
void SetHoleAxisType (NXOpen::CAM::OperationBuilder::HoleAxisTypes types)
 Sets the Hole Axis Type
Created in NX5.0.0. More...
 
void SetHoleAxisValues (const std::vector< double > &holeAxis)
 Set the Hole Axis values
Created in NX5.0.0. More...
 
void SetHoleDepthType (NXOpen::CAM::OperationBuilder::HoleDepthTypes types)
 Sets the Hole Depth Type
Created in NX5.0.0. More...
 
void SetOptimizationBasedOn (NXOpen::CAM::OperationBuilder::OptimizationBasedOnTypes optimBasedOn)
 Sets the optimization based on in operation
Created in NX5.0.0. More...
 
void SetOptimizationDistanceMethod (NXOpen::CAM::OperationBuilder::OptimizationDistanceTypes optimDistance)
 Sets the optimization distance method in operation
Created in NX5.0.0. More...
 
void SetOptimizationLevel (NXOpen::CAM::OperationBuilder::OptimizationLevelTypes optimType)
 Sets the optimization level in operation
Created in NX5.0.0. More...
 
void SetPostToolPathExit (const NXString &exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetPostToolPathExit (const char *exitName)
 Sets the environment variable that points to the post tool path generation library which has the exit
Created in NX9.0.3. More...
 
void SetSelectToolFlag (bool selToolFlag)
 Sets the user selected tool
Created in NX5.0.0. More...
 
NXOpen::CAM::PostEventsCiBuilderStartOfPath ()
 Returns the start event builder
Created in NX5.0.1. More...
 
NXOpen::CAM::UdeSetStartUdeSet ()
 Returns the start ude set
Created in NX7.5.0. More...
 
NXOpen::CAM::ToolChangeCiBuilderToolChangeSetting ()
 Returns the tool change builder
Created in NX5.0.0. More...
 
NXOpen::CAM::ToolPathEditorBuilderToolPathEditor ()
 Returns the Tool Path Editor Builder
Created in NX9.0.3. More...
 
NXOpen::CAM::ToolPathSplitParametersBuilderToolPathSplitParametersBuilder ()
 Returns the tool path split Parameters
Created in NX9.0.0. More...
 
- Public Member Functions inherited from NXOpen::CAM::ParamBuilder
NXOpen::CAM::UdeCycleEvent ()
 Returns the cycle event
Created in NX7.5.0. More...
 
NXOpen::CAM::CycleCycleTable ()
 Returns the cycle
Created in NX9.0.0. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const NXString &name)
 Returns the customizable item builder for the given customizable item name. More...
 
NXOpen::TaggedObjectGetCustomizableItemBuilder (const char *name)
 Returns the customizable item builder for the given customizable item name. More...
 
std::vector< NXStringGetCustomizableItemNames ()
 Returns the names for all customizable item ids. More...
 
NXOpen::CAM::ParamBuilder::OptimizationTypes OptimizationMethod ()
 Returns the optim method
Created in NX5.0.0. More...
 
void SetOptimizationMethod (NXOpen::CAM::ParamBuilder::OptimizationTypes optimMethod)
 Sets the optim method
Created in NX5.0.0. 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 builder for a CMM Inspection Sensor.


To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionSensorBuilder

Created in NX7.0.0.

Member Enumeration Documentation

the sensor tip location method

Enumerator
SensorTipLocationTypesCartesian 

Cartesian.

SensorTipLocationTypesPolar 

Polar.

SensorTipLocationTypesVector 

Vector.

the sensor tip type

Enumerator
SensorTipTypesSphere 

Sphere.

SensorTipTypesCylinder 

Cylinder.

SensorTipTypesDisk 

Disk.

the sensor type

Enumerator
SensorTypesFixed 

Fixed.

SensorTypesIndex 

Indexable.

Member Function Documentation

double NXOpen::CAM::InspectionSensorBuilder::AngleA ( )

Returns the sensor tip location tilt angle component
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionSensorBuilder::AngleB ( )

Returns the sensor tip location rotation angle component
Created in NX7.0.0.



License requirements : None

std::vector<double> NXOpen::CAM::InspectionSensorBuilder::GetSensorTipIjk ( )

Get the sensor tip location vector coordinates.

Returns
the ijk values
Created in NX7.0.0.

License requirements : None
std::vector<double> NXOpen::CAM::InspectionSensorBuilder::GetSensorTipXyz ( )

Get the sensor tip location cartesian coordinates.

Returns
the xyz values
Created in NX7.0.0.

License requirements : None
NXString NXOpen::CAM::InspectionSensorBuilder::MasterOpLabel ( )

Returns the master sensor label
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionSensorBuilder::SensorOpLabel ( )

Returns the sensor label
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionSensorBuilder::SensorOpName ( )

Returns the inspection sensor operation name
Created in NX7.5.1.



License requirements : None

double NXOpen::CAM::InspectionSensorBuilder::SensorTipDiameter ( )

Returns the sensor tip diameter
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionSensorBuilder::SensorTipLength ( )

Returns the sensor tip length
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionSensorBuilder::SensorTipLocationTypes NXOpen::CAM::InspectionSensorBuilder::SensorTipLocation ( )

Returns the sensor tip location method
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionSensorBuilder::SensorTipSize ( )

Returns the sensor tip size
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionSensorBuilder::SensorTipTypes NXOpen::CAM::InspectionSensorBuilder::SensorTipType ( )

Returns the sensor tip type
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InspectionSensorBuilder::SensorTypes NXOpen::CAM::InspectionSensorBuilder::SensorType ( )

Returns the sensor type
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionSensorBuilder::SetAngleA ( double  angle)

Sets the sensor tip location tilt angle component
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleangle
void NXOpen::CAM::InspectionSensorBuilder::SetAngleB ( double  angle)

Sets the sensor tip location rotation angle component
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
angleangle
void NXOpen::CAM::InspectionSensorBuilder::SetMasterOpLabel ( const NXString label)

Sets the master sensor label
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
labellabel
void NXOpen::CAM::InspectionSensorBuilder::SetMasterOpLabel ( const char *  label)

Sets the master sensor label
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
labellabel
void NXOpen::CAM::InspectionSensorBuilder::SetSensorOpLabel ( const NXString label)

Sets the sensor label
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
labellabel
void NXOpen::CAM::InspectionSensorBuilder::SetSensorOpLabel ( const char *  label)

Sets the sensor label
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
labellabel
void NXOpen::CAM::InspectionSensorBuilder::SetSensorOpName ( const NXString sensorOpName)

Sets the inspection sensor operation name
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
sensorOpNamesensoropname
void NXOpen::CAM::InspectionSensorBuilder::SetSensorOpName ( const char *  sensorOpName)

Sets the inspection sensor operation name
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
sensorOpNamesensoropname
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipDiameter ( double  diameter)

Sets the sensor tip diameter
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
diameterdiameter
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipIjk ( const std::vector< double > &  ijk)

Set the sensor tip location vector coordinates
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
ijkthe ijk values
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipLength ( double  length)

Sets the sensor tip length
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
lengthlength
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipLocation ( NXOpen::CAM::InspectionSensorBuilder::SensorTipLocationTypes  type)

Sets the sensor tip location method
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
typetype
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipSize ( double  size)

Sets the sensor tip size
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
sizesize
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipType ( NXOpen::CAM::InspectionSensorBuilder::SensorTipTypes  type)

Sets the sensor tip type
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
typetype
void NXOpen::CAM::InspectionSensorBuilder::SetSensorTipXyz ( const std::vector< double > &  xyz)

Set the sensor tip location cartesian coordinates
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
xyzthe xyz values
void NXOpen::CAM::InspectionSensorBuilder::SetSensorType ( NXOpen::CAM::InspectionSensorBuilder::SensorTypes  type)

Sets the sensor type
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
typetype
void NXOpen::CAM::InspectionSensorBuilder::SetTipNumber ( int  tipNumber)

Sets the probe tip number
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
tipNumbertipnumber
void NXOpen::CAM::InspectionSensorBuilder::SetToolName ( const NXString toolName)

Sets the inspection probe tool name
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
toolNametoolname
void NXOpen::CAM::InspectionSensorBuilder::SetToolName ( const char *  toolName)

Sets the inspection probe tool name
Created in NX7.5.1.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
toolNametoolname
int NXOpen::CAM::InspectionSensorBuilder::TipNumber ( )

Returns the probe tip number
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionSensorBuilder::ToolName ( )

Returns the inspection probe tool name
Created in NX7.5.1.



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.