CAMObject Class¶
-
class
NXOpen.CAM.CAMObject¶ Bases:
NXOpen.NXObjectRepresents interface for all CAM Object
To create or edit an instance of this class, use
NXOpen.CAM.ParamBuilderNew in version NX4.0.0.
Properties¶
| Property | Description |
|---|---|
| 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 |
|---|---|
| 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 encountered with the given Type with option to update or not. |
| 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 @return the boolean value |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetFeedRate | Get the feed rate value and unit of the parameter index from the object @return the feed rate unit |
| GetFeedRateColor | Get the feed rate color of the parameter index from the object. |
| 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. |
| GetObject | Get the object value of the parameter index from the object @return the object value |
| GetObjectArrayValue | Get the object array value of the parameter index from the 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 @return the string value |
| GetTimeAttribute | Gets a time attribute by title. |
| GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
| 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, of the given type. |
| 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. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| 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 with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
| 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. |
| 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. |
| SetIntegerArrayValue | Set integer array value to the parameter index for the object. |
| SetIntegerValue | Set an integer value to the parameter index for the object. |
| 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 |
| 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. |
| 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. |
Enumerations¶
| CAMObjectAttr Enumeration | Represents the CAM attribute type. |
| CAMObjectFeedRateUnit Enumeration | The unit of feed rate |
| CAMObjectStatus Enumeration | The status of the object |
Structs¶
| CAMObjectErrorItem_Struct Struct | Error Item |
Property Detail¶
IsOccurrence¶
-
CAMObject.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¶
-
CAMObject.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¶
-
CAMObject.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¶
-
CAMObject.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponent()Returns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
CAMObject.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.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
CAMObject.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.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
CAMObject.FindObject¶ Finds the
NXOpen.NXObjectwith 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.INXObjectNew in version NX3.0.0.
License requirements: None.
GetBooleanValue¶
-
CAMObject.GetBooleanValue¶ Get the boolean value of the parameter index from the object
Signature
GetBooleanValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the boolean value Return type: bool New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetFeedRate¶
-
CAMObject.GetFeedRate¶ Get the feed rate value and unit of the parameter index from the object
Signature
GetFeedRate(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: a tuple Return type: A tuple consisting of (unit, value). unit is a NXOpen.CAM.CAMObjectFeedRateUnit. the feed rate unit value is a float. the feed rate valueNew in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetFeedRateColor¶
-
CAMObject.GetFeedRateColor¶ Get the feed rate color of the parameter index from the object.
Signature
GetFeedRateColor(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the color number Return type: int New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetIntegerArrayValue¶
-
CAMObject.GetIntegerArrayValue¶ Get the integer array value of the parameter index from the object.
Signature
GetIntegerArrayValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the integer array Return type: list of int New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetIntegerValue¶
-
CAMObject.GetIntegerValue¶ Get the integer value of the parameter index from the object.
Signature
GetIntegerValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the integer value Return type: int New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetObject¶
-
CAMObject.GetObject¶ Get the object value of the parameter index from the object
Signature
GetObject(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the object value Return type: NXOpen.NXObjectNew in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetObjectArrayValue¶
-
CAMObject.GetObjectArrayValue¶ Get the object array value of the parameter index from the object.
Signature
GetObjectArrayValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the object array Return type: list of NXOpen.NXObjectNew in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetRealArrayValue¶
-
CAMObject.GetRealArrayValue¶ Get the real array value of the parameter index from the object.
Signature
GetRealArrayValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the real array Return type: list of float New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetRealValue¶
-
CAMObject.GetRealValue¶ Get the real value of the parameter index from the object.
Signature
GetRealValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the real value Return type: float New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetStatus¶
-
CAMObject.GetStatus¶ Get the status of the input object.
Signature
GetStatus()Returns: the object’s status Return type: NXOpen.CAM.CAMObjectStatusNew in version NX6.0.0.
License requirements: cam_base (“CAM BASE”)
GetStringArrayValue¶
-
CAMObject.GetStringArrayValue¶ Get the string array value of the parameter index from the object.
Signature
GetStringArrayValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the string array Return type: list of str New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetStringValue¶
-
CAMObject.GetStringValue¶ Get the string value of the parameter index from the object
Signature
GetStringValue(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: the string value Return type: str New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
GetWireEdmFeedRate¶
-
CAMObject.GetWireEdmFeedRate¶ Get the feed rate value and side of the parameter index from the object, side is only used in wire edm.
Signature
GetWireEdmFeedRate(title)Parameters: title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter. Returns: a tuple Return type: A tuple consisting of (side, value). side is a int. the feed rate side value is a float. the feed rate value New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
Has911Attribute¶
-
CAMObject.Has911Attribute¶ Check if a 911 attribute exists in an object.
Signature
Has911Attribute(attrId)Parameters: attrId ( NXOpen.CAM.CAMObjectAttr) – the attribute IdReturns: true – 911 attribute exists Return type: bool New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
Print¶
-
CAMObject.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
Remove911Attribute¶
-
CAMObject.Remove911Attribute¶ Remove a specific 911 attribute from an object.
Signature
Remove911Attribute(attrId)Parameters: attrId ( NXOpen.CAM.CAMObjectAttr) – the attribute IdNew in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
RemoveAll911Attributes¶
-
CAMObject.RemoveAll911Attributes¶ Remove all 911 attributes from an object.
Signature
RemoveAll911Attributes()New in version NX5.0.0.
License requirements: cam_base (“CAM BASE”)
SetBooleanValue¶
-
CAMObject.SetBooleanValue¶ Set a boolean value to the parameter index for the object.
Signature
SetBooleanValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (bool) – the boolean value
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetFeedRate¶
-
CAMObject.SetFeedRate¶ Set feed rate value and unit to the parameter index for the object.
Signature
SetFeedRate(title, value, unit)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (float) – the feed rate value
- unit (
NXOpen.CAM.CAMObjectFeedRateUnit) – the feed rate unit
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetFeedRateColor¶
-
CAMObject.SetFeedRateColor¶ Set feed rate display color to the parameter index for the object.
Signature
SetFeedRateColor(title, value)Parameters: - title (str) – the name of the paramter index NOTE: The full Unicode character set is not supported for this parameter.
- value (int) – the color number
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetIntegerArrayValue¶
-
CAMObject.SetIntegerArrayValue¶ Set integer array value to the parameter index for the object.
Signature
SetIntegerArrayValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (list of int) – the integer array
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetIntegerValue¶
-
CAMObject.SetIntegerValue¶ Set an integer value to the parameter index for the object.
Signature
SetIntegerValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (int) – the integer value
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetName¶
-
CAMObject.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.
SetObject¶
-
CAMObject.SetObject¶ Set a object to the parameter index for the object.
Signature
SetObject(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (
NXOpen.NXObject) – the object
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetObjectArrayValue¶
-
CAMObject.SetObjectArrayValue¶ Set object array to the parameter index for the object
Signature
SetObjectArrayValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (list of
NXOpen.NXObject) – the object array
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetRealArrayValue¶
-
CAMObject.SetRealArrayValue¶ Set real array to the parameter index for the object.
Signature
SetRealArrayValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (list of float) – the real array
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetRealValue¶
-
CAMObject.SetRealValue¶ Set a real value to the parameter index for the object.
Signature
SetRealValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (float) – the real value
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetStringArrayValue¶
-
CAMObject.SetStringArrayValue¶ Set string array to the parameter index for the object
Signature
SetStringArrayValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (list of str) – the string array NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetStringValue¶
-
CAMObject.SetStringValue¶ Set a string value to the parameter index for the object.
Signature
SetStringValue(title, value)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (str) – the string value NOTE: The full Unicode character set is not supported for this parameter.
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)
SetWireEdmFeedRate¶
-
CAMObject.SetWireEdmFeedRate¶ Set feed rate value and side to the parameter index for the object, side is only used in wire edm.
Signature
SetWireEdmFeedRate(title, value, side)Parameters: - title (str) – the name of the parameter index NOTE: The full Unicode character set is not supported for this parameter.
- value (float) – the feed rate value
- side (int) – Inside = 0, Outside = 1
New in version NX4.0.0.
License requirements: cam_base (“CAM BASE”)