PointSelectionRecipe Class — NXOpen Python API Reference 12.0.0 documentation

# PointSelectionRecipe Class

class `NXOpen.CAE.``PointSelectionRecipe`

  Bases: `NXOpen.CAE.SelectionRecipe`

  Represents a single node selection recipe based on coordinates of a point

  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.
HighLabelPreference | Returns the high label preference.
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
Point | Returns the point.
Prototype | Returns the prototype of this object if it is an occurrence.
Tag | Returns the Tag for this object.
Tolerance | Returns the tolerance.

# 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.
SetHighLabelPreference | Set the high label preference.
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.
SetPointAndTolerance | Set the target coordinates.
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

## HighLabelPreference

`PointSelectionRecipe.``HighLabelPreference`

  Returns the high label preference.

  False by default.If set to true, the node with the higher label will be picked, in case the recipe finds multiple nodes within tolerance

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

  Getter Method

  Signature `HighLabelPreference`

  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

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

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

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

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

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

## Point

`PointSelectionRecipe.``Point`

  Returns the point.

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

  Getter Method

  Signature `Point`

  Returns: |
  Return type: | `NXOpen.Point`

  New in version NX12.0.0.

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

## Prototype

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

## Tolerance

`PointSelectionRecipe.``Tolerance`

  Returns the tolerance.

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

  Getter Method

  Signature `Tolerance`

  Returns: |
  Return type: | float

  New in version NX12.0.0.

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

# Method Detail

## FindObject

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

## Print

`PointSelectionRecipe.``Print`

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

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## SetHighLabelPreference

`PointSelectionRecipe.``SetHighLabelPreference`

  Set the high label preference.

  Signature `SetHighLabelPreference(useHighLabel)`

  Parameters: | useHighLabel (bool) –

  New in version NX12.0.0.

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

## SetPointAndTolerance

`PointSelectionRecipe.``SetPointAndTolerance`

  Set the target coordinates.

  Signature `SetPointAndTolerance(point, tolerance)`

  Parameters:

  - point (`NXOpen.Point`) –
  - tolerance (float) –

  New in version NX12.0.0.

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