CAMAttribute Class¶
-
class
NXOpen.CAM.
CAMAttribute
¶ Bases:
NXOpen.NXObject
Represents a CAM Feature Attribute
To obtain an instance of this class use
NXOpen.CAM.CAMFeature
New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
DisplayName | Returns or sets the name of the attribute |
IsOccurrence | Returns whether this object is an occurrence or not. |
IsOverridden | Returns the flag that indicates if the attribute is overridden |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Name | Returns the name of the attribute |
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. |
Type | Returns the feature attribute type |
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. |
GetBoolValue | Get the feature attribute boolean value for a boolean type attribute @return |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetDoubleValue | Get the feature attribute double value for a double type attribute @return |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetIntegerValue | Get the feature attribute integer value for an integer type attribute @return |
GetPoint3Value | Get the feature attribute point3 value for a point3 type attribute @return |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetStringValue | Set the feature attribute string value for a string type attribute @return |
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. |
GetVector3Value | Get the feature attribute vector3 value for a vector3 type attribute @return |
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. | |
RemoveOverriddenValue | Sets the overridden attribute value to undefined |
RemoveValue | Sets the attribute value to undefined |
SetAttribute | Creates or modifies an integer attribute. |
SetBoolValue | Set the feature attribute boolean value for a boolean type attribute |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetDoubleValue | Set the feature attribute double value for a double type attribute |
SetIntegerValue | Set the feature attribute integer value for an integer type attribute |
SetName | Sets the custom name of the object. |
SetPoint3Value | Set the feature attribute point3 value for a point3 type attribute |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetStringValue | Get the feature attribute string value for a string type attribute |
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. |
SetVector3Value | Set the feature attribute vector3 value for a vector3 type attribute |
Enumerations¶
CAMAttributeValueType Enumeration | Attribute types |
Property Detail¶
DisplayName¶
-
CAMAttribute.
DisplayName
¶ Returns or sets the name of the attribute
-------------------------------------
Getter Method
Signature
DisplayName()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayName(name)
Parameters: name (str) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
IsOccurrence¶
-
CAMAttribute.
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.
IsOverridden¶
-
CAMAttribute.
IsOverridden
¶ Returns the flag that indicates if the attribute is overridden
-------------------------------------
Getter Method
Signature
IsOverridden()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
JournalIdentifier¶
-
CAMAttribute.
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¶
-
CAMAttribute.
Name
¶ Returns the name of the attribute
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
OwningComponent¶
-
CAMAttribute.
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¶
-
CAMAttribute.
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¶
-
CAMAttribute.
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.
Type¶
-
CAMAttribute.
Type
¶ Returns the feature attribute type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.CAM.CAMAttributeValueType
New in version NX8.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
CAMAttribute.
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.
GetBoolValue¶
-
CAMAttribute.
GetBoolValue
¶ Get the feature attribute boolean value for a boolean type attribute
Signature
GetBoolValue()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
GetDoubleValue¶
-
CAMAttribute.
GetDoubleValue
¶ Get the feature attribute double value for a double type attribute
Signature
GetDoubleValue()
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
GetIntegerValue¶
-
CAMAttribute.
GetIntegerValue
¶ Get the feature attribute integer value for an integer type attribute
Signature
GetIntegerValue()
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
GetPoint3Value¶
-
CAMAttribute.
GetPoint3Value
¶ Get the feature attribute point3 value for a point3 type attribute
Signature
GetPoint3Value()
Returns: Return type: NXOpen.Point3d
New in version NX8.0.0.
License requirements: None.
GetStringValue¶
-
CAMAttribute.
GetStringValue
¶ Set the feature attribute string value for a string type attribute
Signature
GetStringValue()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
GetVector3Value¶
-
CAMAttribute.
GetVector3Value
¶ Get the feature attribute vector3 value for a vector3 type attribute
Signature
GetVector3Value()
Returns: Return type: NXOpen.Vector3d
New in version NX8.0.0.
License requirements: None.
Print¶
-
CAMAttribute.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveOverriddenValue¶
-
CAMAttribute.
RemoveOverriddenValue
¶ Sets the overridden attribute value to undefined
Signature
RemoveOverriddenValue()
New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
RemoveValue¶
-
CAMAttribute.
RemoveValue
¶ Sets the attribute value to undefined
Signature
RemoveValue()
New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
SetBoolValue¶
-
CAMAttribute.
SetBoolValue
¶ Set the feature attribute boolean value for a boolean type attribute
Signature
SetBoolValue(attributeValue)
Parameters: attributeValue (bool) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”), cam_base (“CAM BASE”)
SetDoubleValue¶
-
CAMAttribute.
SetDoubleValue
¶ Set the feature attribute double value for a double type attribute
Signature
SetDoubleValue(attributeValue)
Parameters: attributeValue (float) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”), cam_base (“CAM BASE”)
SetIntegerValue¶
-
CAMAttribute.
SetIntegerValue
¶ Set the feature attribute integer value for an integer type attribute
Signature
SetIntegerValue(attributeValue)
Parameters: attributeValue (int) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”), cam_base (“CAM BASE”)
SetName¶
-
CAMAttribute.
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.
SetPoint3Value¶
-
CAMAttribute.
SetPoint3Value
¶ Set the feature attribute point3 value for a point3 type attribute
Signature
SetPoint3Value(attributeValue)
Parameters: attributeValue ( NXOpen.Point3d
) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”), cam_base (“CAM BASE”)
SetStringValue¶
-
CAMAttribute.
SetStringValue
¶ Get the feature attribute string value for a string type attribute
Signature
SetStringValue(name)
Parameters: name (str) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”), cam_base (“CAM BASE”)
SetVector3Value¶
-
CAMAttribute.
SetVector3Value
¶ Set the feature attribute vector3 value for a vector3 type attribute
Signature
SetVector3Value(attributeValue)
Parameters: attributeValue ( NXOpen.Vector3d
) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”), cam_base (“CAM BASE”)