PmiAttributeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PmiAttributeBuilder Class

class `NXOpen.Annotations.``PmiAttributeBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Annotations.PmiAttribute` builder

  To create a new instance of this class, use `NXOpen.Annotations.PmiAttributeCollection.CreatePmiAttributeBuilder()`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AssociatedObjects | Returns the `NXOpen.Annotations.AssociatedObjectsBuilder` for the annotation
Attribute | Returns or sets the `NXOpen.Annotations.Pmi` for this annotation
BusinessModifier | Returns or sets the business modifier
KnowledgeFusionClassName | Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class
Leader | Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation
Origin | Returns the `NXOpen.Annotations.OriginBuilder` for the annotation
Style | Returns the `NXOpen.Annotations.StyleBuilder` for the annotation
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.
GetAttributeValues | Returns the attribute values
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.
SetAttributeValues | Sets the attribute values
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.

# Property Detail

## AssociatedObjects

`PmiAttributeBuilder.``AssociatedObjects`

  Returns the `NXOpen.Annotations.AssociatedObjectsBuilder` for the annotation

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

  Getter Method

  Signature `AssociatedObjects`

  Returns: |
  Return type: | `NXOpen.Annotations.AssociatedObjectsBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Attribute

`PmiAttributeBuilder.``Attribute`

  Returns or sets the `NXOpen.Annotations.Pmi` for this annotation

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

  Getter Method

  Signature `Attribute`

  Returns: |
  Return type: | `NXOpen.Annotations.Pmi`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Attribute`

  Parameters: | attribute (`NXOpen.Annotations.Pmi`) –

  New in version NX6.0.0.

  License requirements: None.

## BusinessModifier

`PmiAttributeBuilder.``BusinessModifier`

  Returns or sets the business modifier

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

  Getter Method

  Signature `BusinessModifier`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BusinessModifier`

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

  New in version NX6.0.0.

  License requirements: None.

## KnowledgeFusionClassName

`PmiAttributeBuilder.``KnowledgeFusionClassName`

  Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class

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

  Getter Method

  Signature `KnowledgeFusionClassName`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `KnowledgeFusionClassName`

  Parameters: | knowledgeFusionClassName (str) –

  New in version NX6.0.0.

  License requirements: None.

## Leader

`PmiAttributeBuilder.``Leader`

  Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation

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

  Getter Method

  Signature `Leader`

  Returns: |
  Return type: | `NXOpen.Annotations.LeaderBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Origin

`PmiAttributeBuilder.``Origin`

  Returns the `NXOpen.Annotations.OriginBuilder` for the annotation

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

  Getter Method

  Signature `Origin`

  Returns: |
  Return type: | `NXOpen.Annotations.OriginBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Style

`PmiAttributeBuilder.``Style`

  Returns the `NXOpen.Annotations.StyleBuilder` for the annotation

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

  Getter Method

  Signature `Style`

  Returns: |
  Return type: | `NXOpen.Annotations.StyleBuilder`

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## GetAttributeValues

`PmiAttributeBuilder.``GetAttributeValues`

  Returns the attribute values

  Signature `GetAttributeValues()`

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

  New in version NX6.0.0.

  License requirements: None.

## SetAttributeValues

`PmiAttributeBuilder.``SetAttributeValues`

  Sets the attribute values

  Signature `SetAttributeValues(attributeValues)`

  Parameters: | attributeValues (list of `NXOpen.NXObject`) – attribute values

  New in version NX6.0.0.

  License requirements: None.

## Validate

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