SearchCriteriaDatumTargetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SearchCriteriaDatumTargetBuilder Class

class `NXOpen.Annotations.``SearchCriteriaDatumTargetBuilder`

  Bases: `NXOpen.Builder`

  Represents SearchCriteriaDatumTargetBuilder

  To create a new instance of this class, use `NXOpen.Annotations.SearchModelViewCollection.CreateSearchCriteriaDatumTargetBuilder()`

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
ByDatumMovable | Returns or sets the movable datum target option
ByDatumTargetLabel | Returns or sets the datum target label toggle
ByDatumTargetType | Returns or sets the datum target type toggle
ByHeight | Returns or sets the height toggle
ByInnerDiameter | Returns or sets the inner diameter toggle
ByOuterDiameter | Returns or sets the outer diameter toggle
ByText | Returns or sets the text toggle
ByWidth | Returns or sets the width toggle
DatumMovable | Returns or sets the movable datum target type
DatumTargetLabelText | Returns or sets the datum target label text
DatumTargetType | Returns or sets the datum target type enum
HeightType | Returns or sets the height enum
HeightValue | Returns or sets the height value
InnerDiameterType | Returns or sets the inner diameter enum
InnerDiameterValue | Returns or sets the inner diameter value
OuterDiameterType | Returns or sets the outer diameter enum
OuterDiameterValue | Returns or sets the outer diameter value
Tag | Returns the Tag for this object.
Text | Returns or sets the text
TextType | Returns or sets the text enum
WidthType | Returns or sets the width enum
WidthValue | Returns or sets the width value

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SearchCriteriaDatumTargetBuilderDatumTargetMovableOptions Enumeration | Represents the search pmi movable datum target type
SearchCriteriaDatumTargetBuilderDatumTargetTypes Enumeration | Lists the search pmi datum target type

# Property Detail

## ByDatumMovable

`SearchCriteriaDatumTargetBuilder.``ByDatumMovable`

  Returns or sets the movable datum target option

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

  Getter Method

  Signature `ByDatumMovable`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ByDatumMovable`

  Parameters: | datumMovable (bool) –

  New in version NX10.0.0.

  License requirements: None.

## ByDatumTargetLabel

`SearchCriteriaDatumTargetBuilder.``ByDatumTargetLabel`

  Returns or sets the datum target label toggle

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

  Getter Method

  Signature `ByDatumTargetLabel`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByDatumTargetLabel`

  Parameters: | datumTargetLabel (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ByDatumTargetType

`SearchCriteriaDatumTargetBuilder.``ByDatumTargetType`

  Returns or sets the datum target type toggle

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

  Getter Method

  Signature `ByDatumTargetType`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByDatumTargetType`

  Parameters: | datumTargetType (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ByHeight

`SearchCriteriaDatumTargetBuilder.``ByHeight`

  Returns or sets the height toggle

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

  Getter Method

  Signature `ByHeight`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByHeight`

  Parameters: | height (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ByInnerDiameter

`SearchCriteriaDatumTargetBuilder.``ByInnerDiameter`

  Returns or sets the inner diameter toggle

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

  Getter Method

  Signature `ByInnerDiameter`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByInnerDiameter`

  Parameters: | innerDiameter (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ByOuterDiameter

`SearchCriteriaDatumTargetBuilder.``ByOuterDiameter`

  Returns or sets the outer diameter toggle

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

  Getter Method

  Signature `ByOuterDiameter`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByOuterDiameter`

  Parameters: | outerDiameter (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ByText

`SearchCriteriaDatumTargetBuilder.``ByText`

  Returns or sets the text toggle

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

  Getter Method

  Signature `ByText`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByText`

  Parameters: | text (bool) –

  New in version NX7.5.0.

  License requirements: None.

## ByWidth

`SearchCriteriaDatumTargetBuilder.``ByWidth`

  Returns or sets the width toggle

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

  Getter Method

  Signature `ByWidth`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `ByWidth`

  Parameters: | width (bool) –

  New in version NX7.5.0.

  License requirements: None.

## DatumMovable

`SearchCriteriaDatumTargetBuilder.``DatumMovable`

  Returns or sets the movable datum target type

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

  Getter Method

  Signature `DatumMovable`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchCriteriaDatumTargetBuilderDatumTargetMovableOptions`

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DatumMovable`

  Parameters: | datumTargetMovable (`NXOpen.Annotations.SearchCriteriaDatumTargetBuilderDatumTargetMovableOptions`) –

  New in version NX10.0.0.

  License requirements: None.

## DatumTargetLabelText

`SearchCriteriaDatumTargetBuilder.``DatumTargetLabelText`

  Returns or sets the datum target label text

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

  Getter Method

  Signature `DatumTargetLabelText`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DatumTargetLabelText`

  Parameters: | datumTargetLabelText (str) –

  New in version NX7.5.0.

  License requirements: None.

## DatumTargetType

`SearchCriteriaDatumTargetBuilder.``DatumTargetType`

  Returns or sets the datum target type enum

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

  Getter Method

  Signature `DatumTargetType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchCriteriaDatumTargetBuilderDatumTargetTypes`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DatumTargetType`

  Parameters: | datumTargetType (`NXOpen.Annotations.SearchCriteriaDatumTargetBuilderDatumTargetTypes`) –

  New in version NX7.5.0.

  License requirements: None.

## HeightType

`SearchCriteriaDatumTargetBuilder.``HeightType`

  Returns or sets the height enum

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

  Getter Method

  Signature `HeightType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HeightType`

  Parameters: | heightType (`NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## HeightValue

`SearchCriteriaDatumTargetBuilder.``HeightValue`

  Returns or sets the height value

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

  Getter Method

  Signature `HeightValue`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `HeightValue`

  Parameters: | heightValue (float) –

  New in version NX7.5.0.

  License requirements: None.

## InnerDiameterType

`SearchCriteriaDatumTargetBuilder.``InnerDiameterType`

  Returns or sets the inner diameter enum

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

  Getter Method

  Signature `InnerDiameterType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InnerDiameterType`

  Parameters: | innerDiameterType (`NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## InnerDiameterValue

`SearchCriteriaDatumTargetBuilder.``InnerDiameterValue`

  Returns or sets the inner diameter value

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

  Getter Method

  Signature `InnerDiameterValue`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `InnerDiameterValue`

  Parameters: | innerDiameterValue (float) –

  New in version NX7.5.0.

  License requirements: None.

## OuterDiameterType

`SearchCriteriaDatumTargetBuilder.``OuterDiameterType`

  Returns or sets the outer diameter enum

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

  Getter Method

  Signature `OuterDiameterType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OuterDiameterType`

  Parameters: | outerDiameterType (`NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## OuterDiameterValue

`SearchCriteriaDatumTargetBuilder.``OuterDiameterValue`

  Returns or sets the outer diameter value

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

  Getter Method

  Signature `OuterDiameterValue`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `OuterDiameterValue`

  Parameters: | outerDiameterValue (float) –

  New in version NX7.5.0.

  License requirements: None.

## Text

`SearchCriteriaDatumTargetBuilder.``Text`

  Returns or sets the text

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

  Getter Method

  Signature `Text`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Text`

  Parameters: | text (str) –

  New in version NX7.5.0.

  License requirements: None.

## TextType

`SearchCriteriaDatumTargetBuilder.``TextType`

  Returns or sets the text enum

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

  Getter Method

  Signature `TextType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `TextType`

  Parameters: | textType (`NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## WidthType

`SearchCriteriaDatumTargetBuilder.``WidthType`

  Returns or sets the width enum

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

  Getter Method

  Signature `WidthType`

  Returns: |
  Return type: | `NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `WidthType`

  Parameters: | widthType (`NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## WidthValue

`SearchCriteriaDatumTargetBuilder.``WidthValue`

  Returns or sets the width value

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

  Getter Method

  Signature `WidthValue`

  Returns: |
  Return type: | float

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `WidthValue`

  Parameters: | widthValue (float) –

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## Validate

`SearchCriteriaDatumTargetBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.