ShipAttributeHolder Class — NXOpen Python API Reference 12.0.0 documentation

# ShipAttributeHolder Class

class `NXOpen.Features.ShipDesign.``ShipAttributeHolder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.ShipDesign.ShipAttributeHolder` builder

  This is an abstract class.

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CopyAttributesToObjects | Copies attributes from proxy to feature objects
CopyAttributesToPart | Copies the attributes to part
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAttributeProxy | Gets attribute proxy
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetContextAttributeFromNamesBuilder | Gets context attribute from names builder
GetObject | Returns the object currently being edited by this builder.
SetAttributeToProxyFromBuilder | Sets attribute proxy
SetAttributesToObjects | Sets the attributes to feature objects
SetAttributesToProxy | Sets the attributes to proxy
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.

# Method Detail

## CopyAttributesToObjects

`ShipAttributeHolder.``CopyAttributesToObjects`

  Copies attributes from proxy to feature objects

  Signature `CopyAttributesToObjects(bCreate, featBuilder)`

  Parameters:

  - bCreate (bool) – create or edit
  - featBuilder (`NXOpen.Features.FeatureBuilder`) –

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## CopyAttributesToPart

`ShipAttributeHolder.``CopyAttributesToPart`

  Overloaded method CopyAttributesToPart

  - `CopyAttributesToPart(object)`
  - `CopyAttributesToPart(bCreate, featBuilder)`

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

  Copies the attributes to part

  Signature `CopyAttributesToPart(object)`

  Parameters: | object (list of `NXOpen.NXObject`) –

  New in version NX8.0.0.

  Deprecated since version NX8.0.1: This method is no longer valid. Use the un-deprecated method with the same method name.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

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

  Copies the attributes from proxy to part

  Signature `CopyAttributesToPart(bCreate, featBuilder)`

  Parameters:

  - bCreate (bool) – create or edit
  - featBuilder (`NXOpen.Features.FeatureBuilder`) –

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

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

## GetAttributeProxy

`ShipAttributeHolder.``GetAttributeProxy`

  Gets attribute proxy

  Signature `GetAttributeProxy()`

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

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## GetContextAttributeFromNamesBuilder

`ShipAttributeHolder.``GetContextAttributeFromNamesBuilder`

  Gets context attribute from names builder

  Signature `GetContextAttributeFromNamesBuilder(featBuilder)`

  Parameters: | featBuilder (`NXOpen.Features.FeatureBuilder`) –

  New in version NX11.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## SetAttributeToProxyFromBuilder

`ShipAttributeHolder.``SetAttributeToProxyFromBuilder`

  Sets attribute proxy

  Signature `SetAttributeToProxyFromBuilder(featBuilder)`

  Parameters: | featBuilder (`NXOpen.Features.FeatureBuilder`) –

  New in version NX8.5.0.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## SetAttributesToObjects

`ShipAttributeHolder.``SetAttributesToObjects`

  Overloaded method SetAttributesToObjects

  - `SetAttributesToObjects(object)`
  - `SetAttributesToObjects(bCreate, featBuilder)`

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

  Sets the attributes to feature objects

  Signature `SetAttributesToObjects(object)`

  Parameters: | object (list of `NXOpen.NXObject`) –

  New in version NX8.0.0.

  Deprecated since version NX8.0.1: Use `NXOpen.Features.ShipDesign.ShipAttributeHolder.SetAttributesToProxy()` instead.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

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

  Sets the attributes to objects

  Signature `SetAttributesToObjects(bCreate, featBuilder)`

  Parameters:

  - bCreate (bool) – create or edit
  - featBuilder (`NXOpen.Features.FeatureBuilder`) –

  New in version NX8.0.1.

  Deprecated since version NX8.0.2: Use `NXOpen.Features.ShipDesign.ShipAttributeHolder.SetAttributesToProxy()` instead.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

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

## SetAttributesToProxy

`ShipAttributeHolder.``SetAttributesToProxy`

  Sets the attributes to proxy

  Signature `SetAttributesToProxy(object)`

  Parameters: | object (`NXOpen.NXObject`) – NULL or object to be edited

  New in version NX8.0.1.

  License requirements: nx_ship_detail (“Ship Detail Design”) OR nx_ship_mfg_prep (“Ship Manufacturing”)

## Validate

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