CAMFeature Class¶
-
class
NXOpen.CAM.CAMFeature¶ Bases:
NXOpen.CAM.FBM.FeatureRepresents a CAM Feature
To obtain an instance of this class use
NXOpen.CAM.FeatureRecognitionBuilderNew in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| CoordinateSystem | Returns the coordinate system of the CAMFeature |
| 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 or sets the name of the CAMFeature |
| 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. |
| SourceType | Returns the source of the CAMFeature |
| Status | Returns the update status of the CAMFeature |
| Tag | Returns the Tag for this object. |
| Type | Returns the type name of the CAMFeature |
| Attributes | The attributes of the machining feature |
Methods¶
| Method | Description |
|---|---|
| ApproveChanges | Approve changes on a CAMFeature |
| CreateAttributeIterator | Create an attribute iterator |
| 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. |
| FlipDirection | Flip feature direction |
| GetAttribute | Gets and attribute |
| GetAttributeDoubleValue | Returns the actual attribute value |
| GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
| GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
| GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
| GetFaces | Get the faces associated with the CAMFeature |
| GetGeometry | Get the geometry links associated with the feature |
| GetGroups | Get the feature groups in which the CAMFeature is classified |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| GetMachiningArea | Returns the machining area the input entity is part of. |
| GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
| GetOperations | Get the operations manufacturing the CAMFeature |
| GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
| GetProcessStatus | Get the process status of the CAMFeature in the context of a feature group |
| 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. |
| 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, 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. |
| HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator |
| IsAttributeOverridden | Returns true if attribute is overridden |
| OverrideAttributeValue | Overrides the attribute value |
| Prints a representation of this object to the system log file. | |
| ResetAttributeValue | Resets an attribute to its original value |
| ResetAttributes | Resets all attributes to their original value |
| SetAttribute | Sets the attribute value(s) to the same value(s) as another attribute |
| SetAttributeValue | Sets the attribute value |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetCoordinateSystem | Change the feature coordinate system |
| SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object. |
| SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
| 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. |
| Unlock | Unlock Feature |
Enumerations¶
| CAMFeatureProcessStatus Enumeration | Process status of the feature |
| CAMFeatureState Enumeration | Update status of the feature |
Property Detail¶
CoordinateSystem¶
-
CAMFeature.CoordinateSystem¶ Returns the coordinate system of the CAMFeature
-------------------------------------Getter Method
Signature
CoordinateSystemReturns: Return type: NXOpen.CartesianCoordinateSystemNew in version NX8.0.0.
License requirements: None.
IsOccurrence¶
-
CAMFeature.IsOccurrence¶ Returns whether this object is an occurrence or not.
-------------------------------------Getter Method
Signature
IsOccurrenceReturns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
CAMFeature.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
JournalIdentifierReturns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
CAMFeature.Name¶ Returns or sets the name of the CAMFeature
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX7.5.0.
License requirements: cam_base (“CAM BASE”)
OwningComponent¶
-
CAMFeature.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponentReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
CAMFeature.OwningPart¶ Returns the owning part of this object
-------------------------------------Getter Method
Signature
OwningPartReturns: 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¶
-
CAMFeature.Prototype¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------Getter Method
Signature
PrototypeReturns: 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.
SourceType¶
-
CAMFeature.SourceType¶ Returns the source of the CAMFeature
-------------------------------------Getter Method
Signature
SourceTypeReturns: Return type: str New in version NX7.5.0.
License requirements: None.
Status¶
-
CAMFeature.Status¶ Returns the update status of the CAMFeature
-------------------------------------Getter Method
Signature
StatusReturns: Return type: NXOpen.CAM.CAMFeatureStateNew in version NX7.5.0.
License requirements: None.
Type¶
-
CAMFeature.Type¶ Returns the type name of the CAMFeature
-------------------------------------Getter Method
Signature
TypeReturns: Return type: str New in version NX7.5.0.
License requirements: None.
Attributes¶
-
CAMFeature.Attributes¶ The attributes of the machining feature
Signature
AttributesNew in version NX8.0.0.
Returns: Return type: NXOpen.CAM.CAMAttributeCollection
Method Detail¶
ApproveChanges¶
-
CAMFeature.ApproveChanges¶ Approve changes on a CAMFeature
Signature
ApproveChanges()New in version NX7.5.1.
License requirements: cam_base (“CAM BASE”)
FindObject¶
-
CAMFeature.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.
GetFaces¶
-
CAMFeature.GetFaces¶ Get the faces associated with the CAMFeature
Signature
GetFaces()Returns: Return type: list of NXOpen.FaceNew in version NX7.5.0.
License requirements: None.
GetGeometry¶
-
CAMFeature.GetGeometry¶ Get the geometry links associated with the feature
Signature
GetGeometry()Returns: Return type: list of NXOpen.DisplayableObjectNew in version NX8.5.0.
License requirements: None.
GetGroups¶
-
CAMFeature.GetGroups¶ Get the feature groups in which the CAMFeature is classified
Signature
GetGroups()Returns: Return type: list of NXOpen.CAM.NCGroupNew in version NX7.5.0.
License requirements: None.
GetOperations¶
-
CAMFeature.GetOperations¶ Get the operations manufacturing the CAMFeature
Signature
GetOperations()Returns: Return type: list of NXOpen.CAM.OperationNew in version NX7.5.0.
License requirements: None.
GetProcessStatus¶
-
CAMFeature.GetProcessStatus¶ Get the process status of the CAMFeature in the context of a feature group
Signature
GetProcessStatus(group)Parameters: group ( NXOpen.CAM.NCGroup) – feature group for the operation process contextReturns: Return type: NXOpen.CAM.CAMFeatureProcessStatusNew in version NX7.5.0.
License requirements: None.