LineDesignerMappingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LineDesignerMappingBuilder Class

class `NXOpen.AME.``LineDesignerMappingBuilder`

  Bases: `NXOpen.Builder`

  Line Designer mapping dialog JA interface

  To create a new instance of this class, use `NXOpen.AME.AMEManager.CreateLineDesignerMappingBuilder()`

  Default values.

  Property | Value
  --- | ---
  EnumFilter | Unhidden

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
EnumFilter | Returns or sets the enum filter
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateEngineeringObjectAndMap | Creates a new automation designer object and maps it to a line designer 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.
GetObject | Returns the object currently being edited by this builder.
Hide | Hide a ld object
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Unhide | Unhide a ld object
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

LineDesignerMappingBuilderFilterType Enumeration | enum for the filter

# Property Detail

## EnumFilter

`LineDesignerMappingBuilder.``EnumFilter`

  Returns or sets the enum filter

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

  Getter Method

  Signature `EnumFilter`

  Returns: |
  Return type: | `NXOpen.AME.LineDesignerMappingBuilderFilterType`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `EnumFilter`

  Parameters: | enumFilter (`NXOpen.AME.LineDesignerMappingBuilderFilterType`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## CreateEngineeringObjectAndMap

`LineDesignerMappingBuilder.``CreateEngineeringObjectAndMap`

  Overloaded method CreateEngineeringObjectAndMap

  - `CreateEngineeringObjectAndMap(ldObject)`
  - `CreateEngineeringObjectAndMap(ldObjects)`

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

  Creates a new automation designer object and maps it to a line designer object.

  Signature `CreateEngineeringObjectAndMap(ldObject)`

  Parameters: | ldObject (`NXOpen.NXObject`) –
  Returns: |
  Return type: | `NXOpen.NXObject`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Creates new automation designer objects and maps them to line designer objects in bulk.

  Signature `CreateEngineeringObjectAndMap(ldObjects)`

  Parameters: | ldObjects (list of `NXOpen.NXObject`) – Line designer objects to map
  Returns: | Mapped automation designer objects
  Return type: | list of `NXOpen.NXObject`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

## Hide

`LineDesignerMappingBuilder.``Hide`

  Hide a ld object

  Signature `Hide(ldObject)`

  Parameters: | ldObject (`NXOpen.NXObject`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Unhide

`LineDesignerMappingBuilder.``Unhide`

  Unhide a ld object

  Signature `Unhide(ldObject)`

  Parameters: | ldObject (`NXOpen.NXObject`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

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