DrawingAnnotationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DrawingAnnotationBuilder Class

class `NXOpen.Features.ShipDesign.``DrawingAnnotationBuilder`

  Bases: `NXOpen.Builder`

  This builder allows you to define the drawing annotation information.

  It represents `NXOpen.Features.ShipDesign.DrawingAnnotationBuilder`

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

  Default values.

  Property | Value
  --- | ---
  ExistingAutomaticAnnotation | Preserve
  IsCreateOpeningFillLines | 1
  IsCreateScantling | 1
  IsCreateScantlingTable | 1
  IsCreateStructureID | 0

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
ExistingAutomaticAnnotation | Returns or sets the option specify how to handle existing annotation
IsCreateContinuitySymbolOnSectionStiffener | Returns or sets the setting that indicates whether continuity symbol on section stiffener will be created for the ship objects
IsCreateOpeningFillLines | Returns or sets the setting that indicates whether opening fill lines will be created for ship objects
IsCreateScantling | Returns or sets the setting that indicates whether scantling will be created for the ship objects
IsCreateScantlingTable | Returns or sets the setting that indicates whether the most common scantlings for stiffener and plate will be created for the view.
IsCreateStiffenerSectionSymbol | Returns or sets the setting that indicates whether the section symbol will be created for stiffeners
IsCreateStructureID | Returns or sets the setting that indicates whether structure id will be created for ship objects
Tag | Returns the Tag for this object.
ViewList | Returns the drafting views to be annotated

# 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

DrawingAnnotationBuilderAnnotation Enumeration | Settings that indicate how to handle the exsiting annotation in the drawing.

# Property Detail

## ExistingAutomaticAnnotation

`DrawingAnnotationBuilder.``ExistingAutomaticAnnotation`

  Returns or sets the option specify how to handle existing annotation

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

  Getter Method

  Signature `ExistingAutomaticAnnotation`

  Returns: |
  Return type: | `NXOpen.Features.ShipDesign.DrawingAnnotationBuilderAnnotation`

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExistingAutomaticAnnotation`

  Parameters: | existingAutomaticAnnotation (`NXOpen.Features.ShipDesign.DrawingAnnotationBuilderAnnotation`) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## IsCreateContinuitySymbolOnSectionStiffener

`DrawingAnnotationBuilder.``IsCreateContinuitySymbolOnSectionStiffener`

  Returns or sets the setting that indicates whether continuity symbol on section stiffener will be created for the ship objects

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

  Getter Method

  Signature `IsCreateContinuitySymbolOnSectionStiffener`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCreateContinuitySymbolOnSectionStiffener`

  Parameters: | isCreateContinuitySymbolOnSectionStiffener (bool) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## IsCreateOpeningFillLines

`DrawingAnnotationBuilder.``IsCreateOpeningFillLines`

  Returns or sets the setting that indicates whether opening fill lines will be created for ship objects

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

  Getter Method

  Signature `IsCreateOpeningFillLines`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCreateOpeningFillLines`

  Parameters: | isCreateOpeningFillLines (bool) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## IsCreateScantling

`DrawingAnnotationBuilder.``IsCreateScantling`

  Returns or sets the setting that indicates whether scantling will be created for the ship objects

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

  Getter Method

  Signature `IsCreateScantling`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCreateScantling`

  Parameters: | isCreateScantling (bool) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## IsCreateScantlingTable

`DrawingAnnotationBuilder.``IsCreateScantlingTable`

  Returns or sets the setting that indicates whether the most common scantlings for stiffener and plate will be created for the view.

  If yes, the stiffener and plate scantlings, other than the most common one, will not be created.

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

  Getter Method

  Signature `IsCreateScantlingTable`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCreateScantlingTable`

  Parameters: | isCreateScantlingTable (bool) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## IsCreateStiffenerSectionSymbol

`DrawingAnnotationBuilder.``IsCreateStiffenerSectionSymbol`

  Returns or sets the setting that indicates whether the section symbol will be created for stiffeners

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

  Getter Method

  Signature `IsCreateStiffenerSectionSymbol`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCreateStiffenerSectionSymbol`

  Parameters: | isCreateStiffenerSectionSymbol (bool) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## IsCreateStructureID

`DrawingAnnotationBuilder.``IsCreateStructureID`

  Returns or sets the setting that indicates whether structure id will be created for ship objects

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

  Getter Method

  Signature `IsCreateStructureID`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsCreateStructureID`

  Parameters: | isCreateStructureID (bool) –

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## ViewList

`DrawingAnnotationBuilder.``ViewList`

  Returns the drafting views to be annotated

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

  Getter Method

  Signature `ViewList`

  Returns: |
  Return type: | `NXOpen.Drawings.SelectDraftingViewList`

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## Validate

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