DatumReferenceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DatumReferenceBuilder Class

class `NXOpen.Annotations.``DatumReferenceBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Annotations.DatumReferenceBuilder`

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

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
FreeState | Returns or sets the datum reference free state
Letter | Returns or sets the datum reference datum letter
MaterialCondition | Returns or sets the datum reference material condition
Projected | Returns or sets the datum reference projected
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DatumReferenceBuilderDatumReferenceMaterialCondition Enumeration | Specifies the material modifier condition for the datum reference

# Property Detail

## FreeState

`DatumReferenceBuilder.``FreeState`

  Returns or sets the datum reference free state

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

  Getter Method

  Signature `FreeState`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FreeState`

  Parameters: | datumReferenceFreeState (bool) –

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## Letter

`DatumReferenceBuilder.``Letter`

  Returns or sets the datum reference datum letter

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

  Getter Method

  Signature `Letter`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Letter`

  Parameters: | datumReferenceDatum (str) –

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## MaterialCondition

`DatumReferenceBuilder.``MaterialCondition`

  Returns or sets the datum reference material condition

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

  Getter Method

  Signature `MaterialCondition`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaterialCondition`

  Parameters: | materialCondition (`NXOpen.Annotations.DatumReferenceBuilderDatumReferenceMaterialCondition`) –

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## Projected

`DatumReferenceBuilder.``Projected`

  Returns or sets the datum reference projected

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

  Getter Method

  Signature `Projected`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Projected`

  Parameters: | datumReferenceProjected (bool) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

# Method Detail

## Validate

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