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

Represents a CMM Inspection Line Feature builder
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionLineFeatureBuilder

Created in NX7.0.0. More...

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

Public Member Functions

NXOpen::CAM::CamInspectionOperationCsysreferencetypes CsysRefType ()
 Returns the coordinate system reference type
Created in NX7.0.0. More...
 
NXOpen::CAM::CamInspectionOperationExtenttypes ExtentType ()
 Returns the extent type of the line (bounded or unbounded)
Created in NX7.0.0. More...
 
void FlipLineDirection ()
 Flips direction of line. More...
 
void FlipNormal ()
 Flips normal of underlying surface
Created in NX7.0.0. More...
 
double ILine ()
 Returns the I component of the lines direction vector
Created in NX7.0.0. More...
 
double INormal ()
 Returns the I component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0. More...
 
double JLine ()
 Returns the J component of the lines direction vector
Created in NX7.0.0. More...
 
double JNormal ()
 Returns the J component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0. More...
 
double KLine ()
 Returns the K component of the lines direction vector
Created in NX7.0.0. More...
 
double KNormal ()
 Returns the K component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0. More...
 
double Length ()
 Returns the length of the line
Created in NX7.0.0. More...
 
NXOpen::DirectionLineDirection ()
 Returns the line direction vector
Created in NX7.0.0. More...
 
NXString Name ()
 Returns the name of the line feature
Created in NX7.0.0. More...
 
NXOpen::CAM::InheritableDoubleBuilderOffsetDistance ()
 Returns the offset distance
Created in NX9.0.0. More...
 
bool ReverseDirection ()
 Returns the reverse direction button
Created in NX7.0.0. More...
 
void ReverseOffsetDirection ()
 Reverses the offset direction
Created in NX9.0.0. More...
 
NXOpen::SelectNXObjectSelectLine ()
 Returns the selected line
Created in NX7.0.0. More...
 
NXOpen::SelectNXObjectSelectNormalSurface ()
 Returns the underlying surface used to determine the normal and approach direction vectors
Created in NX7.0.0. More...
 
void SetCsysRefType (NXOpen::CAM::CamInspectionOperationCsysreferencetypes csysRefType)
 Sets the coordinate system reference type
Created in NX7.0.0. More...
 
void SetExtentType (NXOpen::CAM::CamInspectionOperationExtenttypes extentType)
 Sets the extent type of the line (bounded or unbounded)
Created in NX7.0.0. More...
 
void SetILine (double iLine)
 Sets the I component of the lines direction vector
Created in NX7.0.0. More...
 
void SetINormal (double iNormal)
 Sets the I component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0. More...
 
void SetJLine (double jLine)
 Sets the J component of the lines direction vector
Created in NX7.0.0. More...
 
void SetJNormal (double jNormal)
 Sets the J component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0. More...
 
void SetKLine (double kLine)
 Sets the K component of the lines direction vector
Created in NX7.0.0. More...
 
void SetKNormal (double kNormal)
 Sets the K component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0. More...
 
void SetLength (double length)
 Sets the length of the line
Created in NX7.0.0. More...
 
void SetLineDirection (NXOpen::Direction *lineDirection)
 Sets the line direction vector
Created in NX7.0.0. More...
 
void SetName (const NXString &name)
 Sets the name of the line feature
Created in NX7.0.0. More...
 
void SetName (const char *name)
 Sets the name of the line feature
Created in NX7.0.0. More...
 
void SetNormalSurface (NXOpen::Face *normalSurface)
 Sets the underlying normal surface
Created in NX9.0.0. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the reverse direction button
Created in NX7.0.0. More...
 
void SetX (double x)
 Sets the X coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0. More...
 
void SetY (double y)
 Sets the Y coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0. More...
 
void SetZ (double z)
 Sets the Z coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0. More...
 
void UpdateNormal ()
 Updates normal vector for line based on selection of underlying plane
Created in NX7.0.0. More...
 
void UpdateOffset ()
 Updates line inspection feature characteristic parameters based on offset distance
Created in NX9.0.0. More...
 
void UpdateParams ()
 Updates line inspection feature characteristic parameters based on selected geometry
Created in NX7.0.0. More...
 
double X ()
 Returns the X coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0. More...
 
double Y ()
 Returns the Y coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0. More...
 
double Z ()
 Returns the Z coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0. 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...
 

Additional Inherited Members

- 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...
 

Detailed Description

Represents a CMM Inspection Line Feature builder
To create a new instance of this class, use NXOpen::CAM::InspectionOperationCollection::CreateInspectionLineFeatureBuilder

Created in NX7.0.0.


Member Function Documentation

NXOpen::CAM::CamInspectionOperationCsysreferencetypes NXOpen::CAM::InspectionLineFeatureBuilder::CsysRefType ( )

Returns the coordinate system reference type
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::CamInspectionOperationExtenttypes NXOpen::CAM::InspectionLineFeatureBuilder::ExtentType ( )

Returns the extent type of the line (bounded or unbounded)
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionLineFeatureBuilder::FlipLineDirection ( )

Flips direction of line.

Moves xyz location to other end of line
Created in NX7.0.0.

License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionLineFeatureBuilder::FlipNormal ( )

Flips normal of underlying surface
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

double NXOpen::CAM::InspectionLineFeatureBuilder::ILine ( )

Returns the I component of the lines direction vector
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::INormal ( )

Returns the I component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::JLine ( )

Returns the J component of the lines direction vector
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::JNormal ( )

Returns the J component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::KLine ( )

Returns the K component of the lines direction vector
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::KNormal ( )

Returns the K component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::Length ( )

Returns the length of the line
Created in NX7.0.0.



License requirements : None

NXOpen::Direction* NXOpen::CAM::InspectionLineFeatureBuilder::LineDirection ( )

Returns the line direction vector
Created in NX7.0.0.



License requirements : None

NXString NXOpen::CAM::InspectionLineFeatureBuilder::Name ( )

Returns the name of the line feature
Created in NX7.0.0.



License requirements : None

NXOpen::CAM::InheritableDoubleBuilder* NXOpen::CAM::InspectionLineFeatureBuilder::OffsetDistance ( )

Returns the offset distance
Created in NX9.0.0.



License requirements : None

bool NXOpen::CAM::InspectionLineFeatureBuilder::ReverseDirection ( )

Returns the reverse direction button
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionLineFeatureBuilder::ReverseOffsetDirection ( )

Reverses the offset direction
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

NXOpen::SelectNXObject* NXOpen::CAM::InspectionLineFeatureBuilder::SelectLine ( )

Returns the selected line
Created in NX7.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::CAM::InspectionLineFeatureBuilder::SelectNormalSurface ( )

Returns the underlying surface used to determine the normal and approach direction vectors
Created in NX7.0.0.



License requirements : None

void NXOpen::CAM::InspectionLineFeatureBuilder::SetCsysRefType ( NXOpen::CAM::CamInspectionOperationCsysreferencetypes  csysRefType)

Sets the coordinate system reference type
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
csysRefTypecsysreftype
void NXOpen::CAM::InspectionLineFeatureBuilder::SetExtentType ( NXOpen::CAM::CamInspectionOperationExtenttypes  extentType)

Sets the extent type of the line (bounded or unbounded)
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
extentTypeextenttype
void NXOpen::CAM::InspectionLineFeatureBuilder::SetILine ( double  iLine)

Sets the I component of the lines direction vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
iLineiline
void NXOpen::CAM::InspectionLineFeatureBuilder::SetINormal ( double  iNormal)

Sets the I component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
iNormalinormal
void NXOpen::CAM::InspectionLineFeatureBuilder::SetJLine ( double  jLine)

Sets the J component of the lines direction vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
jLinejline
void NXOpen::CAM::InspectionLineFeatureBuilder::SetJNormal ( double  jNormal)

Sets the J component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
jNormaljnormal
void NXOpen::CAM::InspectionLineFeatureBuilder::SetKLine ( double  kLine)

Sets the K component of the lines direction vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
kLinekline
void NXOpen::CAM::InspectionLineFeatureBuilder::SetKNormal ( double  kNormal)

Sets the K component of the lines normal vector as determined by an underlying surface
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
kNormalknormal
void NXOpen::CAM::InspectionLineFeatureBuilder::SetLength ( double  length)

Sets the length of the line
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
lengthlength
void NXOpen::CAM::InspectionLineFeatureBuilder::SetLineDirection ( NXOpen::Direction lineDirection)

Sets the line direction vector
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
lineDirectionlinedirection
void NXOpen::CAM::InspectionLineFeatureBuilder::SetName ( const NXString name)

Sets the name of the line feature
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
namename
void NXOpen::CAM::InspectionLineFeatureBuilder::SetName ( const char *  name)

Sets the name of the line feature
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
namename
void NXOpen::CAM::InspectionLineFeatureBuilder::SetNormalSurface ( NXOpen::Face normalSurface)

Sets the underlying normal surface
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
normalSurfacenormalsurface
void NXOpen::CAM::InspectionLineFeatureBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the reverse direction button
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
reverseDirectionreversedirection
void NXOpen::CAM::InspectionLineFeatureBuilder::SetX ( double  x)

Sets the X coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
xx
void NXOpen::CAM::InspectionLineFeatureBuilder::SetY ( double  y)

Sets the Y coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
yy
void NXOpen::CAM::InspectionLineFeatureBuilder::SetZ ( double  z)

Sets the Z coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

Parameters
zz
void NXOpen::CAM::InspectionLineFeatureBuilder::UpdateNormal ( )

Updates normal vector for line based on selection of underlying plane
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionLineFeatureBuilder::UpdateOffset ( )

Updates line inspection feature characteristic parameters based on offset distance
Created in NX9.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

void NXOpen::CAM::InspectionLineFeatureBuilder::UpdateParams ( )

Updates line inspection feature characteristic parameters based on selected geometry
Created in NX7.0.0.



License requirements : insp_programming ("INSPECTION PROGRAMMING")

double NXOpen::CAM::InspectionLineFeatureBuilder::X ( )

Returns the X coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::Y ( )

Returns the Y coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.0.0.



License requirements : None

double NXOpen::CAM::InspectionLineFeatureBuilder::Z ( )

Returns the Z coordinate of one end of a bounded line or any point on an unbounded line
Created in NX7.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.