FeatureGeometryGroup Class¶
-
class
NXOpen.CAM.
FeatureGeometryGroup
¶ Bases:
NXOpen.CAM.FeatureGeometry
Represents a CAM Feature Group
To obtain an instance of this class use
NXOpen.CAM.FeatureRecognitionBuilder
New in version NX8.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 or sets the name of the feature group |
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. |
Status | Returns the update status of the feature group |
Tag | Returns the Tag for this object. |
Type | Returns the feature type of the feature group |
Methods¶
Method | Description |
---|---|
AddFeature | Adds a feature to the feature geometry group |
AskPathExists | Tells if the object has a path |
CreateAttributeIterator | Create an attribute iterator |
CreateEmptyPath | Create an empty path for the object |
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 CAM. |
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. |
GetFeatures | Get the features in the feature group |
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. |
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. |
GetMembers | Get all members of the group(single level) |
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. |
GetOperations | Get the operations of the feature group |
GetParent | Get parent of the group |
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. |
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. |
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. |
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 |
Prints a representation of this object to the system log file. | |
Redistribute | Redistributes the geometry of the feature geometry group |
Remove911Attribute | Remove a specific 911 attribute from an object. |
RemoveAll911Attributes | Remove all 911 attributes from an object. |
RemoveFeature | Removes a feature from the feature geometry group |
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. |
SetIntegerArrayValue | Set integer array value to the parameter index for the object. |
SetIntegerValue | Set an integer value to the parameter index for 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. |
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¶
FeatureGeometryGroupProcessStatus Enumeration | Update status of the feature |
Property Detail¶
IsOccurrence¶
-
FeatureGeometryGroup.
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¶
-
FeatureGeometryGroup.
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¶
-
FeatureGeometryGroup.
Name
¶ Returns or sets the name of the feature group
-------------------------------------
Getter Method
Signature
Name
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Name
Parameters: name (str) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
OwningComponent¶
-
FeatureGeometryGroup.
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¶
-
FeatureGeometryGroup.
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¶
-
FeatureGeometryGroup.
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.
Status¶
-
FeatureGeometryGroup.
Status
¶ Returns the update status of the feature group
-------------------------------------
Getter Method
Signature
Status
Returns: Return type: NXOpen.CAM.FeatureGeometryGroupProcessStatus
New in version NX8.0.0.
License requirements: None.
Method Detail¶
AddFeature¶
-
FeatureGeometryGroup.
AddFeature
¶ Adds a feature to the feature geometry group
Signature
AddFeature(feature)
Parameters: feature ( NXOpen.CAM.CAMFeature
) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
GetFeatures¶
-
FeatureGeometryGroup.
GetFeatures
¶ Get the features in the feature group
Signature
GetFeatures()
Returns: Return type: list of NXOpen.CAM.CAMFeature
New in version NX8.0.0.
License requirements: None.
GetOperations¶
-
FeatureGeometryGroup.
GetOperations
¶ Get the operations of the feature group
Signature
GetOperations()
Returns: Return type: list of NXOpen.CAM.Operation
New in version NX8.0.0.
License requirements: None.
Print¶
-
FeatureGeometryGroup.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
Redistribute¶
-
FeatureGeometryGroup.
Redistribute
¶ Redistributes the geometry of the feature geometry group
Signature
Redistribute()
New in version NX8.5.0.
License requirements: cam_base (“CAM BASE”)
RemoveFeature¶
-
FeatureGeometryGroup.
RemoveFeature
¶ Removes a feature from the feature geometry group
Signature
RemoveFeature(feature)
Parameters: feature ( NXOpen.CAM.CAMFeature
) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)