ExpressionGroup Class

class NXOpen.ExpressionGroup

Bases: NXOpen.NXObject

Represents an expression group.

To create a new instance of this class, use NXOpen.ExpressionGroupCollection.Create()

New in version NX10.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
Parent Returns or sets an expression group’s parent group or None
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.
Visibility Returns or sets an expression group’s visibility

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.
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.
GetExpressions Return an array of expressions in a group.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetMemberGroups Get an array of member expression groups in a group.
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
Print Prints a representation of this object to the system log file.
RemoveExpressions Remove expressions from a group.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetExpressions Add expressions to an expression 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.

Property Detail

IsOccurrence

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

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

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

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

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

Parent

ExpressionGroup.Parent

Returns or sets an expression group’s parent group or None

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

Getter Method

Signature Parent

Returns:Tag of parent group or None
Return type:NXOpen.ExpressionGroup

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Parent

Parameters:parentGroup (NXOpen.ExpressionGroup) – Tag of parent group or None

New in version NX10.0.0.

License requirements: None.

Prototype

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

Visibility

ExpressionGroup.Visibility

Returns or sets an expression group’s visibility

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

Getter Method

Signature Visibility

Returns:True - group visible, False - group invisible
Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Visibility

Parameters:visibile (bool) – True - make group visible, False - make group invisible

New in version NX10.0.0.

License requirements: None.

Method Detail

FindObject

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

GetExpressions

ExpressionGroup.GetExpressions

Return an array of expressions in a group.

Signature GetExpressions()

Returns:array of expressions
Return type:list of NXOpen.Expression

New in version NX10.0.0.

License requirements: None.

GetMemberGroups

ExpressionGroup.GetMemberGroups

Get an array of member expression groups in a group.

To remove member groups, use set_parent property

Signature GetMemberGroups()

Returns:array of expression groups
Return type:list of NXOpen.ExpressionGroup

New in version NX10.0.0.

License requirements: None.

Print

ExpressionGroup.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveExpressions

ExpressionGroup.RemoveExpressions

Remove expressions from a group.

This DOES NOT delete the expression from NX. Once removed from a group, an expression will be added to the Default Group

Signature RemoveExpressions(expressions)

Parameters:expressions (list of NXOpen.Expression) – array of expressions

New in version NX10.0.0.

License requirements: None.

SetExpressions

ExpressionGroup.SetExpressions

Add expressions to an expression group

Signature SetExpressions(expressions)

Parameters:expressions (list of NXOpen.Expression) – array of expressions

New in version NX10.0.0.

License requirements: None.

SetName

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