ExportWorksetForReferenceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ExportWorksetForReferenceBuilder Class

class `NXOpen.PDM.``ExportWorksetForReferenceBuilder`

  Bases: `NXOpen.Builder`, `NXOpen.IAttributeSourceObjectBuilder`

  Represents a builder class that performs Create operations

  To create a new instance of this class, use `NXOpen.PDM.PdmSession.CreateExportWorksetForReferenceBuilder()`

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
DestinationFolder | Returns or sets the export directory path
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AutoAssignAttributes | Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.
AutoAssignAttributesWithNamingPattern | Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.
Commit | Commits any edits that have been applied to the builder.
CreateAttributeTitleToNamingPatternMap | Creates a map object of attribute titles to their corresponding naming pattern
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.
GetObjects | Gets the objects for the modified objects in session.
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.
ValidateObjects | Validate the inputs provided for export

# Property Detail

## DestinationFolder

`ExportWorksetForReferenceBuilder.``DestinationFolder`

  Returns or sets the export directory path

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

  Getter Method

  Signature `DestinationFolder`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DestinationFolder`

  Parameters: | folderPath (str) –

  New in version NX12.0.0.

  License requirements: assemblies (“ASSEMBLIES MODULE”)

# Method Detail

## AutoAssignAttributes

`ExportWorksetForReferenceBuilder.``AutoAssignAttributes`

  Auto assigns the attributes for a given array of objects and returns an array of objects that failed to auto assign.

  Signature `AutoAssignAttributes(objects)`

  Parameters: | objects (list of `NXOpen.NXObject`) –
  Returns: |
  Return type: | `NXOpen.ErrorList`

  New in version NX8.5.0.

  License requirements: None.

## AutoAssignAttributesWithNamingPattern

`ExportWorksetForReferenceBuilder.``AutoAssignAttributesWithNamingPattern`

  Auto assigns the attributes for a given object and returns an array of objects that failed to auto assign.

  properties needs to be created using `CreateAttributeTitleToNamingPatternMap()`

  Signature `AutoAssignAttributesWithNamingPattern(objects, properties)`

  Parameters:

  - objects (list of `NXOpen.NXObject`) –
  - properties (list of `NXOpen.NXObject`) –

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

  New in version NX12.0.0.

  License requirements: None.

## CreateAttributeTitleToNamingPatternMap

`ExportWorksetForReferenceBuilder.``CreateAttributeTitleToNamingPatternMap`

  Creates a map object of attribute titles to their corresponding naming pattern

  Signature `CreateAttributeTitleToNamingPatternMap(attributeTitles, titlePatterns)`

  Parameters:

  - attributeTitles (list of str) –
  - titlePatterns (list of str) –

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

  New in version NX12.0.0.

  License requirements: None.

## GetObjects

`ExportWorksetForReferenceBuilder.``GetObjects`

  Gets the objects for the modified objects in session.

  Signature `GetObjects()`

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

  New in version NX11.0.0.

  License requirements: None.

## Validate

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

## ValidateObjects

`ExportWorksetForReferenceBuilder.``ValidateObjects`

  Validate the inputs provided for export

  Signature `ValidateObjects()`

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

  New in version NX12.0.0.

  License requirements: None.