Feature Class¶
-
class
NXOpen.CAM.FBM.
Feature
¶ Bases:
NXOpen.NXObject
,NXOpen.IFitTo
Interface for CAM Feature objects
This is an abstract class, and cannot be instantiated.
New in version NX9.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 |
---|---|
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. |
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. |
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object. |
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 |
SetName | Sets the custom name of the object. |
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 |
Property Detail¶
IsOccurrence¶
-
Feature.
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¶
-
Feature.
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¶
-
Feature.
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¶
-
Feature.
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¶
-
Feature.
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¶
-
Feature.
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¶
-
Feature.
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.
FlipDirection¶
-
Feature.
FlipDirection
¶ Flip feature direction
Signature
FlipDirection()
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
GetAttribute¶
-
Feature.
GetAttribute
¶ Gets and attribute
Signature
GetAttribute(attributeName)
Parameters: attributeName (str) – the attribute name Returns: the attribute Return type: NXOpen.CAM.CAMAttribute
New in version NX9.0.0.
License requirements: None.
GetAttributeDoubleValue¶
-
Feature.
GetAttributeDoubleValue
¶ Returns the actual attribute value
Signature
GetAttributeDoubleValue(attributeName)
Parameters: attributeName (str) – the attribute name Returns: the attribute value Return type: float New in version NX9.0.0.
License requirements: None.
GetMachiningArea¶
-
Feature.
GetMachiningArea
¶ Returns the machining area the input entity is part of.
If the input entity is not part of the feature the return string is empty
Signature
GetMachiningArea(tagEntit)
Parameters: tagEntit ( NXOpen.DisplayableObject
) – input geometryReturns: Return type: str New in version NX9.0.3.
License requirements: None.
IsAttributeOverridden¶
-
Feature.
IsAttributeOverridden
¶ Returns true if attribute is overridden
Signature
IsAttributeOverridden(attributeName)
Parameters: attributeName (str) – the attribute name Returns: the override flag Return type: bool New in version NX9.0.0.
License requirements: None.
OverrideAttributeValue¶
-
Feature.
OverrideAttributeValue
¶ Overloaded method OverrideAttributeValue
OverrideAttributeValue(attributeName, dValue)
OverrideAttributeValue(attributeName, nValue)
OverrideAttributeValue(attributeName, bValue)
OverrideAttributeValue(attributeName, strValue)
OverrideAttributeValue(attributeName, ptValue)
OverrideAttributeValue(attributeName, vecValue)
-------------------------------------
Overrides the attribute value
Signature
OverrideAttributeValue(attributeName, dValue)
Parameters: - attributeName (str) – the attribute name
- dValue (float) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Overrides the attribute value
Signature
OverrideAttributeValue(attributeName, nValue)
Parameters: - attributeName (str) – the attribute name
- nValue (int) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Overrides the attribute value
Signature
OverrideAttributeValue(attributeName, bValue)
Parameters: - attributeName (str) – the attribute name
- bValue (bool) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Overrides the attribute value
Signature
OverrideAttributeValue(attributeName, strValue)
Parameters: - attributeName (str) – the attribute name
- strValue (str) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Overrides the attribute value
Signature
OverrideAttributeValue(attributeName, ptValue)
Parameters: - attributeName (str) – the attribute name
- ptValue (
NXOpen.Point3d
) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Overrides the attribute value
Signature
OverrideAttributeValue(attributeName, vecValue)
Parameters: - attributeName (str) – the attribute name
- vecValue (
NXOpen.Vector3d
) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Print¶
-
Feature.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
ResetAttributeValue¶
-
Feature.
ResetAttributeValue
¶ Resets an attribute to its original value
Signature
ResetAttributeValue(attributeName)
Parameters: attributeName (str) – the attribute name New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
ResetAttributes¶
-
Feature.
ResetAttributes
¶ Resets all attributes to their original value
Signature
ResetAttributes()
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
SetAttribute¶
-
Feature.
SetAttribute
¶ Overloaded method SetAttribute
SetAttribute(tagAttribute)
SetAttribute(title, value)
SetAttribute(title, value, option)
SetAttribute(title, value)
SetAttribute(title, value, option)
SetAttribute(title, value)
SetAttribute(title, value, option)
SetAttribute(title)
SetAttribute(title, option)
-------------------------------------
Sets the attribute value(s) to the same value(s) as another attribute
Signature
SetAttribute(tagAttribute)
Parameters: tagAttribute ( NXOpen.CAM.CAMAttribute
) – the attributeNew in version NX9.0.1.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Creates or modifies an integer attribute. This method performs an immediate update except when the object is a
NXOpen.Features.Feature
. This method does not support array attributes. 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
SetAttribute(title, value)
Parameters: - title (str) –
- value (int) –
New in version NX3.0.0.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies an integer attribute with the option to update or not. This method does not support array attributes. 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
SetAttribute(title, value, option)
Parameters: - title (str) –
- value (int) –
- option (
NXOpen.UpdateOption
) –
New in version NX5.0.1.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies a real attribute. This method performs an immediate update except when the object is a
NXOpen.Features.Feature
. This method does not support array attributes. 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
SetAttribute(title, value)
Parameters: - title (str) –
- value (float) –
New in version NX3.0.0.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies a real attribute with the option to update or not. This method does not support array attributes. 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
SetAttribute(title, value, option)
Parameters: - title (str) –
- value (float) –
- option (
NXOpen.UpdateOption
) –
New in version NX5.0.1.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies a string attribute. This method performs an immediate update except when the object is a
NXOpen.Features.Feature
. This method does not support array attributes. 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
SetAttribute(title, value)
Parameters: - title (str) –
- value (str) –
New in version NX3.0.0.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies a string attribute with the option to update or not. This method does not support array attributes. 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
SetAttribute(title, value, option)
Parameters: - title (str) –
- value (str) –
- option (
NXOpen.UpdateOption
) –
New in version NX5.0.1.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies a null attribute which is an attribute with a title and no value. This method performs an immediate update except when the object is a
NXOpen.Features.Feature
. This method does not support array attributes. 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
SetAttribute(title)
Parameters: title (str) – New in version NX3.0.0.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
Creates or modifies a null attribute with the option to update or not. This method does not support array attributes. 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
SetAttribute(title, option)
Parameters: - title (str) –
- option (
NXOpen.UpdateOption
) –
New in version NX5.0.1.
Deprecated since version NX8.0.0: Use
SetUserAttribute()
instead.License requirements: None.
-------------------------------------
SetAttributeValue¶
-
Feature.
SetAttributeValue
¶ Overloaded method SetAttributeValue
SetAttributeValue(attributeName, dValue)
SetAttributeValue(attributeName, strValue)
SetAttributeValue(attributeName, nValue)
SetAttributeValue(attributeName, bValue)
-------------------------------------
Sets the attribute value
Signature
SetAttributeValue(attributeName, dValue)
Parameters: - attributeName (str) – the attribute name
- dValue (float) – the attribute value
New in version NX9.0.0.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Sets the attribute value
Signature
SetAttributeValue(attributeName, strValue)
Parameters: - attributeName (str) – the attribute name
- strValue (str) – the attribute value
New in version NX9.0.1.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Sets the attribute value
Signature
SetAttributeValue(attributeName, nValue)
Parameters: - attributeName (str) – the attribute name
- nValue (int) – the attribute value
New in version NX9.0.1.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
Sets the attribute value
Signature
SetAttributeValue(attributeName, bValue)
Parameters: - attributeName (str) – the attribute name
- bValue (bool) – the attribute value
New in version NX9.0.1.
License requirements: cam_base (“CAM BASE”)
-------------------------------------
SetCoordinateSystem¶
-
Feature.
SetCoordinateSystem
¶ Change the feature coordinate system
Signature
SetCoordinateSystem(ptValue, xAxis, yAxis)
Parameters: - ptValue (
NXOpen.Point3d
) – the new feature origin - xAxis (
NXOpen.Vector3d
) – the new feature x axis - yAxis (
NXOpen.Vector3d
) – the new feature y axis
New in version NX9.0.1.
License requirements: cam_base (“CAM BASE”)
- ptValue (
SetName¶
-
Feature.
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.