ReadDataSetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ReadDataSetBuilder Class

class `NXOpen.Features.ShipDesign.``ReadDataSetBuilder`

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

  This class will read a data set file from Team Center

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
CreateDataSetToggle | Returns or sets the property that if the toggle is on then the native file will be added to current work part as a data set
DataSets | Returns or sets the index value of the available data set names
NativeFileBrowser | Returns or sets the file name of the data set from the native file system
NativeToggle | Returns or sets the flag that represents if toggle is on the a file of the data set type can be retrieved from the Native file system
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetDataSetNames | The list of available data set names under the current work part
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## CreateDataSetToggle

`ReadDataSetBuilder.``CreateDataSetToggle`

  Returns or sets the property that if the toggle is on then the native file will be added to current work part as a data set

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

  Getter Method

  Signature `CreateDataSetToggle`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateDataSetToggle`

  Parameters: | createDataSetToggle (bool) –

  New in version NX8.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## DataSets

`ReadDataSetBuilder.``DataSets`

  Returns or sets the index value of the available data set names

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

  Getter Method

  Signature `DataSets`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `DataSets`

  Parameters: | dataSets (int) –

  New in version NX8.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## NativeFileBrowser

`ReadDataSetBuilder.``NativeFileBrowser`

  Returns or sets the file name of the data set from the native file system

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

  Getter Method

  Signature `NativeFileBrowser`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `NativeFileBrowser`

  Parameters: | filename (str) –

  New in version NX8.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

## NativeToggle

`ReadDataSetBuilder.``NativeToggle`

  Returns or sets the flag that represents if toggle is on the a file of the data set type can be retrieved from the Native file system

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

  Getter Method

  Signature `NativeToggle`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

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

  Setter Method

  Signature `NativeToggle`

  Parameters: | nativeToggle (bool) –

  New in version NX8.5.0.

  License requirements: nx_ship_concept (“Ship Concept”)

# Method Detail

## GetDataSetNames

`ReadDataSetBuilder.``GetDataSetNames`

  The list of available data set names under the current work part

  Signature `GetDataSetNames()`

  Returns: | Available data set names derived

  from the input Team Center relations. :rtype: list of str

  New in version NX8.5.0.

  License requirements: None.

## Validate

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