FeatureGroup Class

class NXOpen.Features.FeatureGroup

Bases: NXOpen.Features.Feature

Represents a NXOpen.Features.FeatureGroup

Not support KF.

New in version NX7.5.0.

Properties

Property	Description
AlgorithmVersion	Returns the algorithm version of the feature
AllowDeleteMembers	Returns or sets the allow delete members flag of features group.
ContainerFeature	Returns the container feature for this feature.
FeatureType	Returns the feature type
IsContainedFeature	Returns true if the feature is a contained feature.
IsInternal	Returns true if the feature is internal.
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Location	Returns the location of the feature
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.
Suppressed	Returns the suppression status of the feature
Tag	Returns the Tag for this object.
Timestamp	Returns the timestamp of the feature

Methods

Method	Description
AddMembersWithRelocation	Adds given features into feature group.
BreakWaveLink	Break Wave Link Feature
ChangeBooleanType	Change Boolean Type
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteClueAlerts	Delete all clue alerts from the features
DeleteHintAlerts	Delete all clue alerts from the features
DeleteInformationalAlerts	Delete all informational alerts from the features
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
DeleteWarningAlerts	Delete all warning alerts from the features
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAllChildren	Returns all immediate child features.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetChildren	Returns the immediate child features.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetEntities	Returns the entities created by the feature.
GetExpressions	Returns the expressions created by the feature.
GetFeatureClueHintMessages	Returns both clue and hint messages of the feature.
GetFeatureClueMessages	Returns the feature clue messages.
GetFeatureColor	The feature color
GetFeatureErrorMessages	Returns the feature error messages.
GetFeatureGroupType	Gets the feaure group type.
GetFeatureHintMessages	Returns the feature hint messages.
GetFeatureInformationalMessages	Returns the feature informational messages.
GetFeatureName	Returns the displayed name of the feature.
GetFeatureWarningMessages	Returns the feature warning messages.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetMembers	Gets the members of feature group.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetParents	Returns the immediate parent features.
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.
GetSections	Queries a feature for list of its sections.
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
HideBody	Hide the body created by the feature
HideParents	Hide the body created by the parent feature
Highlight	Highlight the body created by the feature
LogDiagnostic	Log a diagnostic alert for this feature
MakeCurrentFeature	Make current feature
MakeSketchExternal	Make the parent sketch external for reuse by other features.
MakeSketchInternal	Make the parent sketch internal if referenced only by this feature.
MakeTimestampsConsecutive	Try to make timestamps of members of feature group consecutive.
MakeTimestampsSequential	Try to make timestamps of members of feature group sequential.
NewAddMembers	Adds given features into feature group.
NewRemoveMembers	Removes given features from the feature group.
Print	Prints a representation of this object to the system log file.
RemoveAllMembers	Removes all features from the feature group.
RemoveForEdit	Remove all the feature faces before a NoHistory mode edit.
RemoveParameters	Remove Local feature parameters in history free mode.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetFeatureGroupType	Sets the feaure group type.
SetGroupActive	Set a feature group as active group.
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.
ShowBody	Show the body created by the feature.
ShowDimensions	Show all feature dimensions of a feature.
ShowParents	Show the body created by the parent feature.
Suppress	Suppress the feature
Unhighlight	Unhighlight the body created by the feature
Unsuppress	Unsuppress the feature

Enumerations

FeatureGroupType Enumeration

Feature group type.

Property Detail

AllowDeleteMembers

FeatureGroup.AllowDeleteMembers

Returns or sets the allow delete members flag of features group.

-------------------------------------

Getter Method

Signature AllowDeleteMembers

Returns:Allow delete members flag Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AllowDeleteMembers

Parameters:allowDeleteMembers (bool) – Allow delete members flag

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

IsOccurrence

FeatureGroup.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

FeatureGroup.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

FeatureGroup.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

FeatureGroup.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

FeatureGroup.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

FeatureGroup.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

AddMembersWithRelocation

FeatureGroup.AddMembersWithRelocation

Adds given features into feature group.

Signature AddMembersWithRelocation(members, reorderTimestamp, updateRelocatedFeatures)

Parameters:

• members (list of NXOpen.Features.Feature) – Features array
• reorderTimestamp (bool) – Allow reorder member features in order to make members sequential
• updateRelocatedFeatures (bool) – Allow update features when members are made sequential

New in version NX8.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

FindObject

FeatureGroup.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.

GetFeatureGroupType

FeatureGroup.GetFeatureGroupType

Gets the feaure group type.

Signature GetFeatureGroupType()

Returns:Feature group type Return type:NXOpen.Features.FeatureGroupType

New in version NX7.5.0.

License requirements: None.

GetMembers

FeatureGroup.GetMembers

Gets the members of feature group.

Signature GetMembers()

Returns:Features array Return type:list of NXOpen.Features.Feature

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

MakeTimestampsConsecutive

FeatureGroup.MakeTimestampsConsecutive

Try to make timestamps of members of feature group consecutive.

Signature MakeTimestampsConsecutive()

New in version NX7.5.3.

Deprecated since version NX8.5.1: Use NXOpen.Features.FeatureGroup.MakeTimestampsSequential() instead.

License requirements: solid_modeling (“SOLIDS MODELING”)

MakeTimestampsSequential

FeatureGroup.MakeTimestampsSequential

Try to make timestamps of members of feature group sequential.

Signature MakeTimestampsSequential(updateRelocatedFeatures)

Parameters:updateRelocatedFeatures (bool) – Update features when feature group is made sequential

New in version NX8.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

NewAddMembers

FeatureGroup.NewAddMembers

Adds given features into feature group.

Signature NewAddMembers(members, reorderTimestamp)

Parameters:

• members (list of NXOpen.Features.Feature) – Features array
• reorderTimestamp (bool) – Allow reorder member feature in order to make members sequential

New in version NX7.5.3.

Deprecated since version NX8.5.1: Use NXOpen.Features.FeatureGroup.AddMembersWithRelocation() instead.

License requirements: solid_modeling (“SOLIDS MODELING”)

NewRemoveMembers

FeatureGroup.NewRemoveMembers

Removes given features from the feature group.

If reorderTimestamp flag is ture, timestamp of remain member features will be made sequential.

Signature NewRemoveMembers(members, reorderTimestamp)

Parameters:

• members (list of NXOpen.Features.Feature) – Features array
• reorderTimestamp (bool) – Allow reorder member feature in order to make residual members sequential

New in version NX7.5.3.

License requirements: solid_modeling (“SOLIDS MODELING”)

Print

FeatureGroup.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveAllMembers

FeatureGroup.RemoveAllMembers

Removes all features from the feature group.

Signature RemoveAllMembers()

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetFeatureGroupType

FeatureGroup.SetFeatureGroupType

Sets the feaure group type.

Signature SetFeatureGroupType(type)

Parameters:type (NXOpen.Features.FeatureGroupType) – Feature group type

New in version NX7.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetName

FeatureGroup.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.