Represents a NXOpen::Features::ShipDesign::DrawingSheetBuilder . More...

Inheritance diagram for NXOpen::Features::ShipDesign::DrawingSheetBuilder:

Public Types
enum	LayoutOptions { LayoutOptionsHorizontal, LayoutOptionsVertical }
	Settings to indicate the view layout type by row and column in hroizontal or vertical order. More...

Public Member Functions
int	ColumnCount ()
	Returns the number of column into which the views should be arranged on the drawing sheet. More...

NXOpen::Features::ShipDesign::DrawingTemplateBuilder *	DrawingTemplate ()
	Returns the drawing template builder, which represents a NXOpen::Features::ShipDesign::DrawingTemplateBuilder . More...

NXOpen::Features::ShipDesign::DrawingSheetBuilder::LayoutOptions	Layout ()
	Returns the view layout option. More...

int	RowCount ()
	Returns the number of rows into which the views should be arranged on the drawing sheet. More...

void	SetColumnCount (int columnCount)
	Sets the number of column into which the views should be arranged on the drawing sheet. More...

void	SetLayout (NXOpen::Features::ShipDesign::DrawingSheetBuilder::LayoutOptions layout)
	Sets the view layout option. More...

void	SetRowCount (int rowCount)
	Sets the number of rows into which the views should be arranged on the drawing sheet. More...

void	SetSheetName (const NXString &sheetName)
	Sets the drawing sheet name into which the views should be arranged. More...

void	SetSheetName (const char *sheetName)
	Sets the drawing sheet name into which the views should be arranged. More...

void	SetSheetScale (const NXString &sheetScale)
	Sets the sheet scale Created in NX12.0.0. More...

void	SetSheetScale (const char *sheetScale)
	Sets the sheet scale Created in NX12.0.0. More...

NXString	SheetName ()
	Returns the drawing sheet name into which the views should be arranged. More...

NXString	SheetScale ()
	Returns the sheet scale Created in NX12.0.0. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

NXOpen::Features::ShipDesign::SectionViewBuilderList *	ViewList ()
	Returns the section view list Created in NX12.0.1. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Features::ShipDesign::DrawingSheetBuilder::LayoutOptions

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

Enumerator
LayoutOptionsHorizontal	horizontal
LayoutOptionsVertical	vertical

Member Function Documentation

int NXOpen::Features::ShipDesign::DrawingSheetBuilder::ColumnCount ( )

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

Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::DrawingTemplateBuilder* NXOpen::Features::ShipDesign::DrawingSheetBuilder::DrawingTemplate ( )

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

Created in NX12.0.0.

License requirements : None

NXOpen::Features::ShipDesign::DrawingSheetBuilder::LayoutOptions NXOpen::Features::ShipDesign::DrawingSheetBuilder::Layout ( )

Returns the view layout option.

Created in NX12.0.0.

License requirements : None

int NXOpen::Features::ShipDesign::DrawingSheetBuilder::RowCount ( )

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

Created in NX12.0.0.

License requirements : None

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetColumnCount ( int columnCount )

Sets the number of column into which the views should be arranged on the drawing sheet.

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

columnCount columncount

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetLayout ( NXOpen::Features::ShipDesign::DrawingSheetBuilder::LayoutOptions layout )

Sets the view layout option.

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

layout layout

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetRowCount ( int rowCount )

Sets the number of rows into which the views should be arranged on the drawing sheet.

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

rowCount rowcount

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetSheetName ( const NXString & sheetName )

Sets the drawing sheet name into which the views should be arranged.

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

sheetName sheetname

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetSheetName ( const char * sheetName )

Sets the drawing sheet name into which the views should be arranged.

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

sheetName sheetname

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetSheetScale ( const NXString & sheetScale )

Sets the sheet scale
Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

sheetScale sheetscale

void NXOpen::Features::ShipDesign::DrawingSheetBuilder::SetSheetScale ( const char * sheetScale )

Sets the sheet scale
Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters

sheetScale sheetscale

NXString NXOpen::Features::ShipDesign::DrawingSheetBuilder::SheetName ( )

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

Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::ShipDesign::DrawingSheetBuilder::SheetScale ( )

Returns the sheet scale
Created in NX12.0.0.

License requirements : None

virtual bool NXOpen::Features::ShipDesign::DrawingSheetBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXOpen::Features::ShipDesign::SectionViewBuilderList* NXOpen::Features::ShipDesign::DrawingSheetBuilder::ViewList ( )

Returns the section view list
Created in NX12.0.1.

License requirements : None

The documentation for this class was generated from the following file:

Features_ShipDesign_DrawingSheetBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation