PointsFromFileBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PointsFromFileBuilder Class

class `NXOpen.GeometricUtilities.``PointsFromFileBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.GeometricUtilities.PointsFromFileBuilder` builder read points from a text file with format *.

  asc, *.txt, *.dat, *.pts

  To create a new instance of this class, use `NXOpen.Part.CreatePointsFromFileBuilder()`

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
CoordinateOption | Returns or sets the option indicating type of point coordinates
FileName | Returns or sets the file name of the point data file
PathName | Returns or sets the path name of the point data file
Tag | Returns the Tag for this object.

# 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

PointsFromFileBuilderOptions Enumeration | Coordinate option

# Property Detail

## CoordinateOption

`PointsFromFileBuilder.``CoordinateOption`

  Returns or sets the option indicating type of point coordinates

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

  Getter Method

  Signature `CoordinateOption`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.PointsFromFileBuilderOptions`

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CoordinateOption`

  Parameters: | option (`NXOpen.GeometricUtilities.PointsFromFileBuilderOptions`) –

  New in version NX8.5.0.

  License requirements: None.

## FileName

`PointsFromFileBuilder.``FileName`

  Returns or sets the file name of the point data file

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

  Getter Method

  Signature `FileName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FileName`

  Parameters: | filename (str) –

  New in version NX8.5.0.

  License requirements: None.

## PathName

`PointsFromFileBuilder.``PathName`

  Returns or sets the path name of the point data file

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

  Getter Method

  Signature `PathName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `PathName`

  Parameters: | pathname (str) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## Validate

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