SelectionRecipe Class

class NXOpen.CAE.SelectionRecipe

Bases: NXOpen.DisplayableObject

Represents a class NXOpen.CAE.SelectionRecipe.

This is an abstract class

New in version NX12.0.0.

Properties

Property	Description
Color	Returns or sets the color of the object.
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.
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.
Display	Returns the display attributes belonging to the Selection Recipe

Methods

Method	Description
Blank	Blanks the object.
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.
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.
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.
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.
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.
SetName	Sets the name of the Selection Recipe
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.
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

IsOccurrence

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

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

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

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

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

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

Display

SelectionRecipe.Display

Returns the display attributes belonging to the Selection Recipe

Signature Display

New in version NX12.0.0.

Returns: Return type:NXOpen.CAE.SelectionRecipeDisplay

Method Detail

FindObject

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

GetEntities

SelectionRecipe.GetEntities

Gets entities in the Selection Recipe.

Signature GetEntities()

Returns: Return type:list of NXOpen.TaggedObject

New in version NX12.0.0.

License requirements: None.

GetEntityTypes

SelectionRecipe.GetEntityTypes

Returns Entity Types supported by the Selection Recipe.

Signature GetEntityTypes()

Returns:Entity types to which this recipe resolves to. Return type:list of NXOpen.CAE.CaeSetGroupFilterType

New in version NX12.0.0.

License requirements: None.

GetName

SelectionRecipe.GetName

Gets the name of the Selection Recipe

Signature GetName()

Returns: Return type:str

New in version NX12.0.0.

License requirements: None.

HasNonDisplayableEntities

SelectionRecipe.HasNonDisplayableEntities

Returns whether the Selection Recipe has non-displayable entities

Signature HasNonDisplayableEntities()

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

HideContents

SelectionRecipe.HideContents

Hide the contents of the Selection Recipe.

Note that CAE.FEElemEdge, CAE.FEElemFace and CAE.CAEEdge do not participate in this command. They are non-displayable entities and are never drawn individually in NX. Use NXOpen.CAE.SelectionRecipe.HasNonDisplayableEntities() to determine if the Selection Recipe contains these entities.

Signature HideContents()

New in version NX12.0.0.

License requirements: None.

Information

SelectionRecipe.Information

Display information of this Selection Recipe

Signature Information()

New in version NX12.0.0.

License requirements: None.

Print

SelectionRecipe.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

SelectionRecipe.SetName

Sets the name of the Selection Recipe

Signature SetName(name)

Parameters:name (str) –

New in version NX12.0.0.

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

ShowContents

SelectionRecipe.ShowContents

Show the contents of the Selection Recipe.

Note that CAE.FEElemEdge, CAE.FEElemFace and CAE.CAEEdge do not participate in this command. They are non-displayable entities and are never drawn individually in NX. Use NXOpen.CAE.SelectionRecipe.HasNonDisplayableEntities() to determine if the Selection Recipe contains these entities.

Signature ShowContents()

New in version NX12.0.0.

License requirements: None.

ShowContentsOnly

SelectionRecipe.ShowContentsOnly

Shows the contents of the Selection Recipe only.

Note that CAE.FEElemEdge, CAE.FEElemFace and CAE.CAEEdge do not participate in this command. They are non-displayable entities and are never drawn individually in NX. Use NXOpen.CAE.SelectionRecipe.HasNonDisplayableEntities() to determine if the Selection Recipe contains these entities.

Signature ShowContentsOnly()

New in version NX12.0.0.

License requirements: None.