DatumBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DatumBuilder Class

class `NXOpen.Features.``DatumBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a builder for datum features.

  A generic datum feature is positioned via a set of contraints. (See `NXOpen.DatumConstraint`.) The two datum subclasses can be positioned by editig constriants, and can also be edited via a set of explicit methods for setting different constraint types. See `NXOpen.Features.DatumAxisBuilder` and `NXOpen.Features.DatumPlaneBuilder`.

  This is an abstract class, and cannot be instantiated

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreateConstraint | Creates a new empty constraint object.
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.
GetConstraints | Gets the contraint objects that define the positioning of this datum.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetConstraints | Sets the contraint objects that define the positioning of this datum.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Method Detail

## CreateConstraint

`DatumBuilder.``CreateConstraint`

  Creates a new empty constraint object.

  To apply one or more constraints to a feature, see `SetConstraints()`.

  Signature `CreateConstraint()`

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

  New in version NX4.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## GetConstraints

`DatumBuilder.``GetConstraints`

  Gets the contraint objects that define the positioning of this datum.

  Signature `GetConstraints()`

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

  New in version NX4.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetConstraints

`DatumBuilder.``SetConstraints`

  Sets the contraint objects that define the positioning of this datum.

  Signature `SetConstraints(constraints)`

  Parameters: | constraints (list of `NXOpen.DatumConstraint`) –

  New in version NX4.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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