ProxyOverrideObjectBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ProxyOverrideObjectBuilder Class

class `NXOpen.Mechatronics.``ProxyOverrideObjectBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.ProxyOverrideObjectBuilder`.

  To create a new instance of this class, use `NXOpen.Mechatronics.ProxyOverrideObjectCollection.CreateBuilder()`

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
Attachment | Returns the attachment that is encapsulated in the proxy override object
Context | Returns or sets the context part of the proxy override object
HasAttachment | Returns or sets the flag for whether the proxy override object has an attachment
ParameterList | Returns the parameter data
ProxyObject | Returns the proxy object that is encapsulated in the proxy override object
ProxyOverrideObjectName | Returns or sets the name of the proxy override object
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

ProxyOverrideObjectBuilderAttrBoolValue Enumeration | the value for the boolean option
ProxyOverrideObjectBuilderAttrType Enumeration | the parameter attribute option.

# Property Detail

## Attachment

`ProxyOverrideObjectBuilder.``Attachment`

  Returns the attachment that is encapsulated in the proxy override object

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

  Getter Method

  Signature `Attachment`

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

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Context

`ProxyOverrideObjectBuilder.``Context`

  Returns or sets the context part of the proxy override object

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

  Getter Method

  Signature `Context`

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

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Context`

  Parameters: | context (`NXOpen.BasePart`) –

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## HasAttachment

`ProxyOverrideObjectBuilder.``HasAttachment`

  Returns or sets the flag for whether the proxy override object has an attachment

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

  Getter Method

  Signature `HasAttachment`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `HasAttachment`

  Parameters: | hasAttachment (bool) –

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ParameterList

`ProxyOverrideObjectBuilder.``ParameterList`

  Returns the parameter data

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

  Getter Method

  Signature `ParameterList`

  Returns: |
  Return type: | `NXOpen.Mechatronics.ProxyObjectParameterBuilderList`

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ProxyObject

`ProxyOverrideObjectBuilder.``ProxyObject`

  Returns the proxy object that is encapsulated in the proxy override object

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

  Getter Method

  Signature `ProxyObject`

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

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## ProxyOverrideObjectName

`ProxyOverrideObjectBuilder.``ProxyOverrideObjectName`

  Returns or sets the name of the proxy override object

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

  Getter Method

  Signature `ProxyOverrideObjectName`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `ProxyOverrideObjectName`

  Parameters: | proxyOverrideObjectName (str) –

  New in version NX8.5.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## Validate

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