AttributeSelectionRecipe Class — NXOpen Python API Reference 12.0.0 documentation

# AttributeSelectionRecipe Class

class `NXOpen.CAE.``AttributeSelectionRecipe`

  Bases: `NXOpen.CAE.SelectionRecipe`

  Represents a Selection Recipe based on attributes.

  To obtain an instance of this object use one of the creators in `NXOpen.CAE.SelectionRecipeCollection`.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
Color | Returns or sets the color of the object.
ColorAttribute | Returns the color attribute.
HasColorAttribute | Returns the presence of the color attribute.
HasNameAttribute | Returns the presence of the name attribute.
IsBlanked | Returns the blank status of this object.
IsOccurrence | Returns whether this object is an occurrence or not.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Layer | Returns or sets the layer that the object is in.
LineFont | Returns or sets the line font of the object.
LineWidth | Returns or sets the line width of the object.
Name | Returns the custom name of the object.
NameAttribute | Returns the name attribute.
NameLocation | Returns the location of the object’s name.
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
--- | ---
Blank | Blanks the object.
ClearAllAttributes | Clear all attributes
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.
GetEntities | Gets entities in the Selection Recipe.
GetEntityTypes | Returns Entity Types supported by the Selection Recipe.
GetHasUserAttributes | Gets the presence of the user attribute with given name.
GetIntegerAttribute | Gets an integer attribute by title.
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetName | Gets the name of the Selection Recipe
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.
GetUserAttributeNames | Gets the names of all set user attributes.
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 the low and high value of user attribute with given name.
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object.
HasNonDisplayableEntities | Returns whether the Selection Recipe has non-displayable entities
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator
HideContents | Hide the contents of the Selection Recipe.
Highlight | Highlights the object.
Information | Display information of this Selection Recipe
Print | Prints a representation of this object to the system log file.
RedisplayObject | Redisplays the object in all views.
RemoveColorAttribute | Removes the color attribute.
RemoveNameAttribute | Removes the name attribute.
RemoveUserAttributes | Removes the user attribute with given name.
RemoveViewDependency | Remove dependency on all views from an object.
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetColorAttribute | Sets or adds the color attribute.
SetName | Sets the name of the Selection Recipe
SetNameAttribute | Sets or adds the name attribute.
SetNameLocation | Sets the location of the object’s name.
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.
SetUserAttributes | Sets or adds the low and high value of user attribute with given name.
ShowContents | Show the contents of the Selection Recipe.
ShowContentsOnly | Shows the contents of the Selection Recipe only.
Unblank | Unblanks the object.
Unhighlight | Unhighlights the object.

# Property Detail

## ColorAttribute

`AttributeSelectionRecipe.``ColorAttribute`

  Returns the color attribute.

  `-------------------------------------`

  Getter Method

  Signature `ColorAttribute`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## HasColorAttribute

`AttributeSelectionRecipe.``HasColorAttribute`

  Returns the presence of the color attribute.

  `-------------------------------------`

  Getter Method

  Signature `HasColorAttribute`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## HasNameAttribute

`AttributeSelectionRecipe.``HasNameAttribute`

  Returns the presence of the name attribute.

  `-------------------------------------`

  Getter Method

  Signature `HasNameAttribute`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## IsOccurrence

`AttributeSelectionRecipe.``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

`AttributeSelectionRecipe.``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

`AttributeSelectionRecipe.``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.

## NameAttribute

`AttributeSelectionRecipe.``NameAttribute`

  Returns the name attribute.

  `-------------------------------------`

  Getter Method

  Signature `NameAttribute`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## OwningComponent

`AttributeSelectionRecipe.``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

`AttributeSelectionRecipe.``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

`AttributeSelectionRecipe.``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

## ClearAllAttributes

`AttributeSelectionRecipe.``ClearAllAttributes`

  Clear all attributes

  Signature `ClearAllAttributes()`

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## FindObject

`AttributeSelectionRecipe.``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.

## GetHasUserAttributes

`AttributeSelectionRecipe.``GetHasUserAttributes`

  Gets the presence of the user attribute with given name.

  Signature `GetHasUserAttributes(attributeName)`

  Parameters: | attributeName (str) –
  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## GetUserAttributeNames

`AttributeSelectionRecipe.``GetUserAttributeNames`

  Gets the names of all set user attributes.

  Signature `GetUserAttributeNames()`

  Returns: |
  Return type: | list of str

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## GetUserAttributes

`AttributeSelectionRecipe.``GetUserAttributes`

  Overloaded method GetUserAttributes

  - `GetUserAttributes(attributeName)`
  - `GetUserAttributes(iterator)`
  - `GetUserAttributes()`
  - `GetUserAttributes(includeUnset)`
  - `GetUserAttributes(includeUnset, addStringValues)`

  `-------------------------------------`

  Gets the low and high value of user attribute with given name.

  Signature `GetUserAttributes(attributeName)`

  Parameters: | attributeName (str) –
  Returns: | a tuple
  Return type: | A tuple consisting of (lowValueAttribute, highValueAttribute). lowValueAttribute is a `NXOpen.NXObjectAttributeInformation_Struct`. highValueAttribute is a `NXOpen.NXObjectAttributeInformation_Struct`.

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

  Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. The results will not include information from associated attribute templates of unset attributes. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type `NXOpen.NXObjectAttributeType.String`, and both the ReferenceValue and the calculated StringValue are returned.

  Signature `GetUserAttributes(iterator)`

  Parameters: | iterator (`NXOpen.AttributeIterator`) – `NXOpen.AttributeIterator`
  Returns: |
  Return type: | list of `NXOpen.NXObjectAttributeInformation_Struct`

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Gets all the attributes that have been set on the given object. The results will not include information from associated attribute templates of unset attributes. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type `NXOpen.NXObjectAttributeType.String`, and both the ReferenceValue and the calculated StringValue are returned.

  Signature `GetUserAttributes()`

  Returns: |
  Return type: | list of `NXOpen.NXObjectAttributeInformation_Struct`

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Gets all the attributes of the given object. Includes option to return information also from associated attribute templates of unset attributes. The values returned for unset attributes are the default values from the templates. The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returnes as being of type `NXOpen.NXObjectAttributeType.String`, and both the ReferenceValue and the calculated StringValue are returned.

  Signature `GetUserAttributes(includeUnset)`

  Parameters: | includeUnset (bool) –
  Returns: |
  Return type: | list of `NXOpen.NXObjectAttributeInformation_Struct`

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Gets all the attributes of the given object. Includes option to return information also from associated attribute templates of unset attributes. The values returned for unset attributes are the default values from the templates. Includes an option to return the value not only in the natural type, but also converted to a string (effective only for non-string attributes). The elements of array attributes are returned individually in order of increasing indices. The returned Title of an array element is the array title (without index). The Index data member holds the index. The date format set by the Customer Defaults is used. Reference type attributes are returned as being of type `NXOpen.NXObjectAttributeType.String`, and both the ReferenceValue and the calculated StringValue are returned.

  Signature `GetUserAttributes(includeUnset, addStringValues)`

  Parameters:

  - includeUnset (bool) –
  - addStringValues (bool) –

  Returns: |
  Return type: | list of `NXOpen.NXObjectAttributeInformation_Struct`

  New in version NX8.5.0.

  Deprecated since version NX11.0.0: Use `GetUserAttributes()` instead.

  License requirements: None.

  `-------------------------------------`

## Print

`AttributeSelectionRecipe.``Print`

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

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## RemoveColorAttribute

`AttributeSelectionRecipe.``RemoveColorAttribute`

  Removes the color attribute.

  Signature `RemoveColorAttribute()`

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## RemoveNameAttribute

`AttributeSelectionRecipe.``RemoveNameAttribute`

  Removes the name attribute.

  Signature `RemoveNameAttribute()`

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## RemoveUserAttributes

`AttributeSelectionRecipe.``RemoveUserAttributes`

  Removes the user attribute with given name.

  Signature `RemoveUserAttributes(attributeName)`

  Parameters: | attributeName (str) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetColorAttribute

`AttributeSelectionRecipe.``SetColorAttribute`

  Sets or adds the color attribute.

  Signature `SetColorAttribute(color)`

  Parameters: | color (int) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetNameAttribute

`AttributeSelectionRecipe.``SetNameAttribute`

  Sets or adds the name attribute.

  Signature `SetNameAttribute(name)`

  Parameters: | name (str) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetUserAttributes

`AttributeSelectionRecipe.``SetUserAttributes`

  Overloaded method SetUserAttributes

  - `SetUserAttributes(attributeName, lowValueAttribute, highValueAttribute)`
  - `SetUserAttributes(setNameAttribute, nameAttribute, setColorAttribute, colorAttribute, userAttributeNames, lowValueAttributes, highValueAttributes)`

  `-------------------------------------`

  Sets or adds the low and high value of user attribute with given name.

  Signature `SetUserAttributes(attributeName, lowValueAttribute, highValueAttribute)`

  Parameters:

  - attributeName (str) –
  - lowValueAttribute (`NXOpen.NXObjectAttributeInformation_Struct`) –
  - highValueAttribute (`NXOpen.NXObjectAttributeInformation_Struct`) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`

  Convenience method to set multiple attributes at once. The name and color are optional. It’s recommended to use this method in case of setting multiple attributes, to avoid having the recipe resolve multiple times.

  Signature `SetUserAttributes(setNameAttribute, nameAttribute, setColorAttribute, colorAttribute, userAttributeNames, lowValueAttributes, highValueAttributes)`

  Parameters:

  - setNameAttribute (bool) –
  - nameAttribute (str) –
  - setColorAttribute (bool) –
  - colorAttribute (int) –
  - userAttributeNames (list of str) –
  - lowValueAttributes (list of `NXOpen.NXObjectAttributeInformation_Struct`) –
  - highValueAttributes (list of `NXOpen.NXObjectAttributeInformation_Struct`) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

  `-------------------------------------`