GougeCheckBuilder Class

class NXOpen.CAM.GougeCheckBuilder

Bases: NXOpen.Builder

Represents a NXOpen.CAM.GougeCheckBuilder.

Which is for gouge and collision check. When Builder.Commit() is called None will be returned.

To create a new instance of this class, use NXOpen.CAM.CAMSetup.CreateGougeCheckBuilder()

New in version NX11.0.0.

Properties

Property	Description
CheckToolAndHolder	Returns or sets the check tool and holder.
GougeCheckStockOptions	Returns or sets the gouge check stock options.
GougeCheckStockUserDefinedValue	Returns or sets the gouge check stock user defined value.
PauseOnFirstGougeOrCollision	Returns or sets the pause on first gouge or collision.
StopWhenLimitReached	Returns or sets the stop when limit reached.
StopWhenLimitReachedMaximumLimit	Returns or sets the stop when limit reached maximum limit.
Tag	Returns the Tag for this object.
ToolShape	Returns or sets the tool shape.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

GougeCheckBuilderGougeCheckStock Enumeration	the gouge check stock options
GougeCheckBuilderToolShapeType Enumeration	the tool shape options

Property Detail

CheckToolAndHolder

GougeCheckBuilder.CheckToolAndHolder

Returns or sets the check tool and holder.

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

-------------------------------------

Getter Method

Signature CheckToolAndHolder

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CheckToolAndHolder

Parameters:checkToolAndHolder (bool) –

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

GougeCheckStockOptions

GougeCheckBuilder.GougeCheckStockOptions

Returns or sets the gouge check stock options.

This is the setting for the gouge check stock options.

-------------------------------------

Getter Method

Signature GougeCheckStockOptions

Returns:the gouge check stock options Return type:NXOpen.CAM.GougeCheckBuilderGougeCheckStock

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GougeCheckStockOptions

Parameters:options (NXOpen.CAM.GougeCheckBuilderGougeCheckStock) – the gouge check stock options

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

GougeCheckStockUserDefinedValue

GougeCheckBuilder.GougeCheckStockUserDefinedValue

Returns or sets the gouge check stock user defined value.

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

-------------------------------------

Getter Method

Signature GougeCheckStockUserDefinedValue

Returns:the gouge check stock user defined value Return type:float

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GougeCheckStockUserDefinedValue

Parameters:userDefinedValue (float) – the gouge check stock user defined value

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

PauseOnFirstGougeOrCollision

GougeCheckBuilder.PauseOnFirstGougeOrCollision

Returns or sets the pause on first gouge or collision.

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

-------------------------------------

Getter Method

Signature PauseOnFirstGougeOrCollision

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PauseOnFirstGougeOrCollision

Parameters:pauseOnFirstGougeOrCollision (bool) –

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

StopWhenLimitReached

GougeCheckBuilder.StopWhenLimitReached

Returns or sets the stop when limit reached.

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

-------------------------------------

Getter Method

Signature StopWhenLimitReached

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StopWhenLimitReached

Parameters:stopWhenLimitReached (bool) –

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

StopWhenLimitReachedMaximumLimit

GougeCheckBuilder.StopWhenLimitReachedMaximumLimit

Returns or sets the stop when limit reached maximum limit.

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

-------------------------------------

Getter Method

Signature StopWhenLimitReachedMaximumLimit

Returns: Return type:int

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StopWhenLimitReachedMaximumLimit

Parameters:maximumLimit (int) –

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

ToolShape

GougeCheckBuilder.ToolShape

Returns or sets the tool shape.

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

-------------------------------------

Getter Method

Signature ToolShape

Returns:the tool shape type Return type:NXOpen.CAM.GougeCheckBuilderToolShapeType

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToolShape

Parameters:type (NXOpen.CAM.GougeCheckBuilderToolShapeType) – the tool shape type

New in version NX11.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

Validate

GougeCheckBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.