DrawingSheetBuilder Class

class NXOpen.Features.ShipDesign.DrawingSheetBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Features.ShipDesign.DrawingSheetBuilder.

This class is used to define a drawing sheet in NXOpen.Features.ShipDesign.DrawingPartBuilder, in this case user can define the drawing sheet manually as he want. Originally, we use a NXOpen.Features.ShipDesign.SectionDrawingBuilder class and a list of NXOpen.Features.ShipDesign.SectionViewBuilder and the command will calculate the arrangement (like how many drawing parts/draw sheets need to create and which view in which sheet ) automatically. User can’t define which view in which sheet.

In this project we make user has ability to define the arrangement in a tree like Drawing Part1 |- Drawing Sheet1 |-View1 |-View2 |- Drawing Sheet2 |- View3 |- View4 Drawing Part2 | - Drawing Sheet1 |- View5 |- View6

So we add NXOpen.Features.ShipDesign.DrawingPartBuilder and NXOpen.Features.ShipDesign.DrawingSheetBuilder between them and make them has structure as below: NXOpen.Features.ShipDesign.SectionDrawingBuilder NXOpen.Features.ShipDesign.DrawingPartBuilder NXOpen.Features.ShipDesign.DrawingSheetBuilder NXOpen.Features.ShipDesign.SectionViewBuilder

To create a new instance of this class, use NXOpen.Features.ShipDesign.DrawingPartBuilder.CreateDrawingSheetBuilder()

New in version NX12.0.0.

Properties

Property	Description
ColumnCount	Returns or sets the number of column into which the views should be arranged on the drawing sheet.
DrawingTemplate	Returns the drawing template builder, which represents a NXOpen.Features.ShipDesign.DrawingTemplateBuilder.
Layout	Returns or sets the view layout option.
RowCount	Returns or sets the number of rows into which the views should be arranged on the drawing sheet.
SheetName	Returns or sets the drawing sheet name into which the views should be arranged.
SheetScale	Returns or sets the sheet scale
Tag	Returns the Tag for this object.
ViewList	Returns the section view list

Methods

Method	Description
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

DrawingSheetBuilderLayoutOptions Enumeration

Settings to indicate the view layout type by row and column in hroizontal or vertical order.

Property Detail

ColumnCount

DrawingSheetBuilder.ColumnCount

Returns or sets the number of column into which the views should be arranged on the drawing sheet.

-------------------------------------

Getter Method

Signature ColumnCount

Returns: Return type:int

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ColumnCount

Parameters:columnCount (int) –

New in version NX12.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

DrawingTemplate

DrawingSheetBuilder.DrawingTemplate

Returns the drawing template builder, which represents a NXOpen.Features.ShipDesign.DrawingTemplateBuilder.

-------------------------------------

Getter Method

Signature DrawingTemplate

Returns: Return type:NXOpen.Features.ShipDesign.DrawingTemplateBuilder

New in version NX12.0.0.

License requirements: None.

Layout

DrawingSheetBuilder.Layout

Returns or sets the view layout option.

-------------------------------------

Getter Method

Signature Layout

Returns: Return type:NXOpen.Features.ShipDesign.DrawingSheetBuilderLayoutOptions

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Layout

Parameters:layout (NXOpen.Features.ShipDesign.DrawingSheetBuilderLayoutOptions) –

New in version NX12.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

RowCount

DrawingSheetBuilder.RowCount

Returns or sets the number of rows into which the views should be arranged on the drawing sheet.

-------------------------------------

Getter Method

Signature RowCount

Returns: Return type:int

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RowCount

Parameters:rowCount (int) –

New in version NX12.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

SheetName

DrawingSheetBuilder.SheetName

Returns or sets the drawing sheet name into which the views should be arranged.

-------------------------------------

Getter Method

Signature SheetName

Returns: Return type:str

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SheetName

Parameters:sheetName (str) –

New in version NX12.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

SheetScale

DrawingSheetBuilder.SheetScale

Returns or sets the sheet scale

-------------------------------------

Getter Method

Signature SheetScale

Returns: Return type:str

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SheetScale

Parameters:sheetScale (str) –

New in version NX12.0.0.

License requirements: nx_ship_drafting (“Ship Drafting”)

ViewList

DrawingSheetBuilder.ViewList

Returns the section view list

-------------------------------------

Getter Method

Signature ViewList

Returns: Return type:NXOpen.Features.ShipDesign.SectionViewBuilderList

New in version NX12.0.1.

License requirements: None.

Method Detail

Validate

DrawingSheetBuilder.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.