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

Represents a NXOpen::CAM::GougeCheckBuilder . More...

Inheritance diagram for NXOpen::CAM::GougeCheckBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  GougeCheckStock { GougeCheckStockAutomatic, GougeCheckStockUserDefined }
 the gouge check stock options More...
 
enum  ToolShapeType { ToolShapeTypeToolParameters, ToolShapeTypeSolidAssembly }
 the tool shape options More...
 

Public Member Functions

bool CheckToolAndHolder ()
 Returns the check tool and holder. More...
 
NXOpen::CAM::GougeCheckBuilder::GougeCheckStock GougeCheckStockOptions ()
 Returns the gouge check stock options. More...
 
double GougeCheckStockUserDefinedValue ()
 Returns the gouge check stock user defined value. More...
 
bool PauseOnFirstGougeOrCollision ()
 Returns the pause on first gouge or collision. More...
 
void SetCheckToolAndHolder (bool checkToolAndHolder)
 Sets the check tool and holder. More...
 
void SetGougeCheckStockOptions (NXOpen::CAM::GougeCheckBuilder::GougeCheckStock options)
 Sets the gouge check stock options. More...
 
void SetGougeCheckStockUserDefinedValue (double userDefinedValue)
 Sets the gouge check stock user defined value. More...
 
void SetPauseOnFirstGougeOrCollision (bool pauseOnFirstGougeOrCollision)
 Sets the pause on first gouge or collision. More...
 
void SetStopWhenLimitReached (bool stopWhenLimitReached)
 Sets the stop when limit reached. More...
 
void SetStopWhenLimitReachedMaximumLimit (int maximumLimit)
 Sets the stop when limit reached maximum limit. More...
 
void SetToolShape (NXOpen::CAM::GougeCheckBuilder::ToolShapeType type)
 Sets the tool shape. More...
 
bool StopWhenLimitReached ()
 Returns the stop when limit reached. More...
 
int StopWhenLimitReachedMaximumLimit ()
 Returns the stop when limit reached maximum limit. More...
 
NXOpen::CAM::GougeCheckBuilder::ToolShapeType ToolShape ()
 Returns the tool shape. 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 a NXOpen::CAM::GougeCheckBuilder .

Which is for gouge and collision check. When Builder::Commit is called NULL will be returned.
To create a new instance of this class, use NXOpen::CAM::CAMSetup::CreateGougeCheckBuilder

Created in NX11.0.0.

Member Enumeration Documentation

the gouge check stock options

Enumerator
GougeCheckStockAutomatic 

use automatic

GougeCheckStockUserDefined 

use user defined

the tool shape options

Enumerator
ToolShapeTypeToolParameters 

use tool parameters

ToolShapeTypeSolidAssembly 

use solid assembly

Member Function Documentation

bool NXOpen::CAM::GougeCheckBuilder::CheckToolAndHolder ( )

Returns the check tool and holder.

This is the setting for the gouge checking to check tool and holder.


Created in NX11.0.0.

License requirements : None

NXOpen::CAM::GougeCheckBuilder::GougeCheckStock NXOpen::CAM::GougeCheckBuilder::GougeCheckStockOptions ( )

Returns the gouge check stock options.

This is the setting for the gouge check stock options.


Created in NX11.0.0.

License requirements : None

double NXOpen::CAM::GougeCheckBuilder::GougeCheckStockUserDefinedValue ( )

Returns the gouge check stock user defined value.

This is the setting when user selects user defined gouge check stock.


Created in NX11.0.0.

License requirements : None

bool NXOpen::CAM::GougeCheckBuilder::PauseOnFirstGougeOrCollision ( )

Returns the pause on first gouge or collision.

This is the options to stop the gouge checking when encounter first gouge.


Created in NX11.0.0.

License requirements : None

void NXOpen::CAM::GougeCheckBuilder::SetCheckToolAndHolder ( bool  checkToolAndHolder)

Sets the check tool and holder.

This is the setting for the gouge checking to check tool and holder.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
checkToolAndHolderchecktoolandholder
void NXOpen::CAM::GougeCheckBuilder::SetGougeCheckStockOptions ( NXOpen::CAM::GougeCheckBuilder::GougeCheckStock  options)

Sets the gouge check stock options.

This is the setting for the gouge check stock options.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
optionsthe gouge check stock options
void NXOpen::CAM::GougeCheckBuilder::SetGougeCheckStockUserDefinedValue ( double  userDefinedValue)

Sets the gouge check stock user defined value.

This is the setting when user selects user defined gouge check stock.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
userDefinedValuethe gouge check stock user defined value
void NXOpen::CAM::GougeCheckBuilder::SetPauseOnFirstGougeOrCollision ( bool  pauseOnFirstGougeOrCollision)

Sets the pause on first gouge or collision.

This is the options to stop the gouge checking when encounter first gouge.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
pauseOnFirstGougeOrCollisionpauseonfirstgougeorcollision
void NXOpen::CAM::GougeCheckBuilder::SetStopWhenLimitReached ( bool  stopWhenLimitReached)

Sets the stop when limit reached.

This is the options to stop or continue the gouge checking when encounter any gouge.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
stopWhenLimitReachedstopwhenlimitreached
void NXOpen::CAM::GougeCheckBuilder::SetStopWhenLimitReachedMaximumLimit ( int  maximumLimit)

Sets the stop when limit reached maximum limit.

The gouge checking will be stopped when reached the maximum limit.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
maximumLimitmaximumlimit
void NXOpen::CAM::GougeCheckBuilder::SetToolShape ( NXOpen::CAM::GougeCheckBuilder::ToolShapeType  type)

Sets the tool shape.

This is the setting for which tool shape type is used for the gouge checking.


Created in NX11.0.0.

License requirements : cam_base ("CAM BASE")

Parameters
typethe tool shape type
bool NXOpen::CAM::GougeCheckBuilder::StopWhenLimitReached ( )

Returns the stop when limit reached.

This is the options to stop or continue the gouge checking when encounter any gouge.


Created in NX11.0.0.

License requirements : None

int NXOpen::CAM::GougeCheckBuilder::StopWhenLimitReachedMaximumLimit ( )

Returns the stop when limit reached maximum limit.

The gouge checking will be stopped when reached the maximum limit.


Created in NX11.0.0.

License requirements : None

NXOpen::CAM::GougeCheckBuilder::ToolShapeType NXOpen::CAM::GougeCheckBuilder::ToolShape ( )

Returns the tool shape.

This is the setting for which tool shape type is used for the gouge checking.


Created in NX11.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.