GrooveMilling Class — NXOpen Python API Reference 12.0.0 documentation

# GrooveMilling Class

class `NXOpen.CAM.``GrooveMilling`

  Bases: `NXOpen.CAM.VolumeBased25DMillingOperation`

  Represents a Groove Milling Operation

  To create or edit an instance of this class, use `NXOpen.CAM.GrooveMillingBuilder`

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
GougeCheckResults | Returns the Gouge check Results
GougeCheckStatus | Returns the gouge check status
HasOtherInstances | Returns the indicator to show if the operation has other instances
IsDivided | Returns the indicator to show if the operation is result of tool path divide
IsFirstOfDivide | Returns the indicator to show if the operation is the source for tool path divide
IsOccurrence | Returns whether this object is an occurrence or not.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Name | Returns the custom name of the object.
OwningComponent | Returns the owning component, if this object is an occurrence.
OwningPart | Returns the owning part of this object
Prototype | Returns the prototype of this object if it is an occurrence.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AppendMove | Returns the append move
AskPathExists | Tells if the object has a path
CreateAttributeIterator | Create an attribute iterator
CreateEmptyPath | Create an empty path for the object
CreateToolPathEditorBuilder | Create Tool Path Editor Move builder
DeleteAllAttributesByType | Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title.
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject | Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
GetAttributeTitlesByType | Gets all the attribute titles of a specific type.
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index.
GetBooleanValue | Get the boolean value of the parameter index from the object
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index.
GetDividedOperations | Get the divided operations from tool path divide of this operation
GetFeedRate | Get the feed rate value and unit of the parameter index from the object
GetFeedRateColor | Get the feed rate color of the parameter index from the object.
GetFirstOfDivide | Get the first source operation of the divided operation
GetInProcessFeatureType | Get the in process feature type
GetInputIpw | Get input ipw for the operation.
GetIntegerArrayValue | Get the integer array value of the parameter index from the object.
GetIntegerAttribute | Gets an integer attribute by title.
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetIntegerValue | Get the integer value of the parameter index from the object.
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetObject | Get the object value of the parameter index from the object
GetObjectArrayValue | Get the object array value of the parameter index from the object.
GetOtherInstances | Get the other instances of the operation
GetParent | Get parent
GetPath | Returns the path
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object.
GetRealArrayValue | Get the real array value of the parameter index from the object.
GetRealAttribute | Gets a real attribute by title.
GetRealUserAttribute | Gets a real attribute by Title and array Index.
GetRealValue | Get the real value of the parameter index from the object.
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStatus | Get the status of the input object.
GetStringArrayValue | Get the string array value of the parameter index from the object.
GetStringAttribute | Gets a string attribute value by title.
GetStringUserAttribute | Gets a string attribute by Title and array Index.
GetStringValue | Get the string value of the parameter index from the object
GetTimeAttribute | Gets a time attribute by title.
GetTimeUserAttribute | Gets a time attribute by Title and array Index.
GetToolpathCuttingLength | Returns toolpath cutting length in Part units (mm or inch)
GetToolpathCuttingTime | Returns toolpath cutting time in seconds
GetToolpathLength | Returns toolpath length in Part units (mm or inch)
GetToolpathTime | Returns toolpath time in seconds
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock | Determine the lock of the given attribute.
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes.
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object.
GetUserDefinedMoveTypes | Get the valid User Defined Move Types
GetWireEdmFeedRate | Get the feed rate value and side of the parameter index from the object, side is only used in wire edm.
Has911Attribute | Check if a 911 attribute exists in an object.
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator
InsertFeature | Insert a machining feature to machine and returns an in process feature
InsertMove | Returns the insert move
Print | Prints a representation of this object to the system log file.
Remove911Attribute | Remove a specific 911 attribute from an object.
RemoveAll911Attributes | Remove all 911 attributes from an object.
RemoveFeature | Remove a machining feature
SavePath | This must be called to establish proper part status
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetBooleanValue | Set a boolean value to the parameter index for the object.
SetFeedRate | Set feed rate value and unit to the parameter index for the object.
SetFeedRateColor | Set feed rate display color to the parameter index for the object.
SetInProcessFeatureType | Set the in process feature type
SetIntegerArrayValue | Set integer array value to the parameter index for the object.
SetIntegerValue | Set an integer value to the parameter index for the object.
SetMachiningArea | Set machining area
SetName | Sets the custom name of the object.
SetObject | Set a object to the parameter index for the object.
SetObjectArrayValue | Set object array to the parameter index for the object
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object.
SetRealArrayValue | Set real array to the parameter index for the object.
SetRealValue | Set a real value to the parameter index for the object.
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string.
SetStringArrayValue | Set string array to the parameter index for the object
SetStringValue | Set a string value to the parameter index for the object.
SetTimeAttribute | Creates or modifies a time attribute.
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not.
SetToolpathCuttingLength | Sets toolpath cutting length in Part units (mm or inch)
SetToolpathCuttingTime | Sets toolpath cutting time in seconds
SetToolpathLength | Sets toolpath length in Part units (mm or inch)
SetToolpathTime | Sets toolpath time in seconds
SetUserAttribute | Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock | Lock or unlock the given attribute.
SetWireEdmFeedRate | Set feed rate value and side to the parameter index for the object, side is only used in wire edm.
UnlinkInstance | Unlink instance

# Property Detail

## IsOccurrence

`GrooveMilling.``IsOccurrence`

  Returns whether this object is an occurrence or not.

  `-------------------------------------`

  Getter Method

  Signature `IsOccurrence`

  Returns: | This object is an occurrence
  Return type: | bool

  New in version NX3.0.0.

  License requirements: None.

## JournalIdentifier

`GrooveMilling.``JournalIdentifier`

  Returns the identifier that would be recorded in a journal for this object.

  This may not be the same across different releases of the software.

  `-------------------------------------`

  Getter Method

  Signature `JournalIdentifier`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## Name

`GrooveMilling.``Name`

  Returns the custom name of the object.

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## OwningComponent

`GrooveMilling.``OwningComponent`

  Returns the owning component, if this object is an occurrence.

  `-------------------------------------`

  Getter Method

  Signature `OwningComponent`

  Returns: |
  Return type: | `NXOpen.Assemblies.Component`

  New in version NX3.0.0.

  License requirements: None.

## OwningPart

`GrooveMilling.``OwningPart`

  Returns the owning part of this object

  `-------------------------------------`

  Getter Method

  Signature `OwningPart`

  Returns: | The owning part of this object or null if it does not have an owner
  Return type: | `NXOpen.BasePart`

  New in version NX3.0.0.

  License requirements: None.

## Prototype

`GrooveMilling.``Prototype`

  Returns the prototype of this object if it is an occurrence.

  `-------------------------------------`

  Getter Method

  Signature `Prototype`

  Returns: | The prototype of this object or null if this object is not an occurrence
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

# Method Detail

## FindObject

`GrooveMilling.``FindObject`

  Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.

  An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

  An exception will be thrown if no object can be found with the given journal identifier.

  Signature `FindObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Journal identifier of the object
  Returns: |
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

## Print

`GrooveMilling.``Print`

  Prints a representation of this object to the system log file.

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## SetName

`GrooveMilling.``SetName`

  Sets the custom name of the object.

  NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

  Signature `SetName(name)`

  Parameters: | name (str) –

  New in version NX3.0.0.

  License requirements: None.