CutDepthChecker Class¶
-
class
NXOpen.CAM.
CutDepthChecker
¶ Bases:
NXOpen.Builder
Represents a cut depth checker object
This has not creator
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
CheckNeck | Returns or sets the indicator to include tool neck in the collision check process |
CreateCurvesForGouges | Returns or sets the indicator to create curves for the gouged motions |
CutVolume | Returns the calculated cut volume |
DisplayGouges | Returns or sets the indicator to display gouges |
MaxCutDepthViolation | Returns the maximum cut depth violation |
NumCutDepthViolations | Returns the number of cut depth violations |
OperationToCheck | Returns or sets the operation that is being checked |
PauseOnGouge | Returns or sets the indicator for pausing on gouge |
StopLimit | Returns or sets the number of gouges to be used as a limit to stop |
StopOnLimit | Returns or sets the indicator to stop when the number of gouges has equalled the stop limit |
Tag | Returns the Tag for this object. |
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. |
PerformCheck | The action to perform the check |
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. |
Property Detail¶
CheckNeck¶
-
CutDepthChecker.
CheckNeck
¶ Returns or sets the indicator to include tool neck in the collision check process
-------------------------------------
Getter Method
Signature
CheckNeck()
Returns: indicator to include tool neck in the collision check process Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CheckNeck(newValue)
Parameters: newValue (bool) – indicator to include tool neck in the collision check process New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
CreateCurvesForGouges¶
-
CutDepthChecker.
CreateCurvesForGouges
¶ Returns or sets the indicator to create curves for the gouged motions
-------------------------------------
Getter Method
Signature
CreateCurvesForGouges()
Returns: indicator to create curves for the gouged motions Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateCurvesForGouges(newValue)
Parameters: newValue (bool) – indicator to create curves for the gouged motions New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
CutVolume¶
-
CutDepthChecker.
CutVolume
¶ Returns the calculated cut volume
-------------------------------------
Getter Method
Signature
CutVolume()
Returns: calculated cut volume Return type: float New in version NX8.5.0.
License requirements: None.
DisplayGouges¶
-
CutDepthChecker.
DisplayGouges
¶ Returns or sets the indicator to display gouges
-------------------------------------
Getter Method
Signature
DisplayGouges()
Returns: indicator to display gouges Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayGouges(newValue)
Parameters: newValue (bool) – indicator to display gouges New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
MaxCutDepthViolation¶
-
CutDepthChecker.
MaxCutDepthViolation
¶ Returns the maximum cut depth violation
-------------------------------------
Getter Method
Signature
MaxCutDepthViolation()
Returns: the maximum cut depth violation Return type: float New in version NX8.5.0.
License requirements: None.
NumCutDepthViolations¶
-
CutDepthChecker.
NumCutDepthViolations
¶ Returns the number of cut depth violations
-------------------------------------
Getter Method
Signature
NumCutDepthViolations()
Returns: the number of cut depth violations Return type: int New in version NX8.5.0.
License requirements: None.
OperationToCheck¶
-
CutDepthChecker.
OperationToCheck
¶ Returns or sets the operation that is being checked
-------------------------------------
Getter Method
Signature
OperationToCheck()
Returns: the operation which has to be checked Return type: NXOpen.CAM.Operation
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OperationToCheck(operation)
Parameters: operation ( NXOpen.CAM.Operation
) – the operation which has to be checkedNew in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
PauseOnGouge¶
-
CutDepthChecker.
PauseOnGouge
¶ Returns or sets the indicator for pausing on gouge
-------------------------------------
Getter Method
Signature
PauseOnGouge()
Returns: indicator for pausing on gouge Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PauseOnGouge(newValue)
Parameters: newValue (bool) – indicator for pausing on gouge New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
StopLimit¶
-
CutDepthChecker.
StopLimit
¶ Returns or sets the number of gouges to be used as a limit to stop
-------------------------------------
Getter Method
Signature
StopLimit()
Returns: the number of gouges to be used as a limit to stop Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StopLimit(newValue)
Parameters: newValue (int) – the number of gouges to be used as a limit to stop New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
StopOnLimit¶
-
CutDepthChecker.
StopOnLimit
¶ Returns or sets the indicator to stop when the number of gouges has equalled the stop limit
-------------------------------------
Getter Method
Signature
StopOnLimit()
Returns: the number of gouges to be used as a limit to stop Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StopOnLimit(newValue)
Parameters: newValue (bool) – the number of gouges to be used as a limit to stop New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
PerformCheck¶
-
CutDepthChecker.
PerformCheck
¶ The action to perform the check
Signature
PerformCheck()
New in version NX8.5.0.
License requirements: None.
Validate¶
-
CutDepthChecker.
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.