MapleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MapleBuilder Class

class `NXOpen.Features.``MapleBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.Maple` builder

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateMapleBuilder()`

  Default values.

  Property | Value
  --- | ---
  AssociativityEnumType | None
  AssociativityToggle | 0
  SettingsToggle | 0

  New in version NX7.5.0.

  Deprecated since version NX12.0.0: Use `NXOpen.Features.MathIntegrationBuilder` instead.

# Properties

Property | Description
--- | ---
AssociativityEnumType | Returns or sets the associativity type
AssociativityToggle | Returns or sets the associativity of the expression in the NX feature to the Symbolica or Maple worksheet
FileBrowser | Returns or sets the file name returned by the Browser
Inputs | Returns or sets the number of input expressions
Location | Returns or sets the source location of the Symbolica or Maple worksheet.
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
SettingsToggle | Returns or sets the option to show the information window
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
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.
GetExpressions | The array of expressions
GetFeature | Returns the feature currently being edited by this builder.
GetMaplenames | The array of maple names
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.
SetExpressions | Set the expressions in the Maple Builder
SetMaplenames | Set the maple names corresponding to expressions in the Maple Builder
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.

# Enumerations

MapleBuilderAssociativityEnum Enumeration | the associativity type
MapleBuilderLocationType Enumeration | The option to specify where the Symbolica or Maple worksheet exists.

# Property Detail

## AssociativityEnumType

`MapleBuilder.``AssociativityEnumType`

  Returns or sets the associativity type

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

  Getter Method

  Signature `AssociativityEnumType`

  Returns: |
  Return type: | `NXOpen.Features.MapleBuilderAssociativityEnum`

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AssociativityEnumType`

  Parameters: | associativityEnumType (`NXOpen.Features.MapleBuilderAssociativityEnum`) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## AssociativityToggle

`MapleBuilder.``AssociativityToggle`

  Returns or sets the associativity of the expression in the NX feature to the Symbolica or Maple worksheet

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

  Getter Method

  Signature `AssociativityToggle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `AssociativityToggle`

  Parameters: | associativityToggle (bool) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## FileBrowser

`MapleBuilder.``FileBrowser`

  Returns or sets the file name returned by the Browser

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

  Getter Method

  Signature `FileBrowser`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `FileBrowser`

  Parameters: | filename (str) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Inputs

`MapleBuilder.``Inputs`

  Returns or sets the number of input expressions

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

  Getter Method

  Signature `Inputs`

  Returns: |
  Return type: | int

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `Inputs`

  Parameters: | numInputExpressions (int) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Location

`MapleBuilder.``Location`

  Returns or sets the source location of the Symbolica or Maple worksheet.

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

  Getter Method

  Signature `Location`

  Returns: |
  Return type: | `NXOpen.Features.MapleBuilderLocationType`

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Location`

  Parameters: | location (`NXOpen.Features.MapleBuilderLocationType`) –

  New in version NX12.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SettingsToggle

`MapleBuilder.``SettingsToggle`

  Returns or sets the option to show the information window

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

  Getter Method

  Signature `SettingsToggle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `SettingsToggle`

  Parameters: | settingsToggle (bool) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## GetExpressions

`MapleBuilder.``GetExpressions`

  The array of expressions

  Signature `GetExpressions()`

  Returns: | array of expressions
  Return type: | list of `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## GetMaplenames

`MapleBuilder.``GetMaplenames`

  The array of maple names

  Signature `GetMaplenames()`

  Returns: | array of names
  Return type: | list of str

  New in version NX7.5.0.

  License requirements: None.

## SetExpressions

`MapleBuilder.``SetExpressions`

  Set the expressions in the Maple Builder

  Signature `SetExpressions(expressions)`

  Parameters: | expressions (list of `NXOpen.Expression`) – array of expressions

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SetMaplenames

`MapleBuilder.``SetMaplenames`

  Set the maple names corresponding to expressions in the Maple Builder

  Signature `SetMaplenames(names)`

  Parameters: | names (list of str) – array of names

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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