NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::ShipDesign::DrawingPartBuilder Class Reference

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

Inheritance diagram for NXOpen::Features::ShipDesign::DrawingPartBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Features::ShipDesign::DrawingSheetBuilderCreateDrawingSheetBuilder (NXOpen::Drawings::DrawingSheet *drawingSheet)
 Creates a NXOpen::Features::ShipDesign::DrawingSheetBuilder. More...
 
NXString DrawingName ()
 Returns the drawing name
Created in NX12.0.0. More...
 
NXOpen::Features::ShipDesign::DrawingSheetBuilderListDrawingSheetList ()
 Returns the drawing sheet list
Created in NX12.0.0. More...
 
void SetDrawingName (const NXString &drawingName)
 Sets the drawing name
Created in NX12.0.0. More...
 
void SetDrawingName (const char *drawingName)
 Sets the drawing name
Created in NX12.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. 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::DrawingPartBuilder .

This class is used to define a drawing part in Ship Section Drawing command, in this case user can define the drawing part 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::SectionDrawingBuilder::CreateDrawingPartBuilder

Created in NX12.0.0.

Member Function Documentation

NXOpen::Features::ShipDesign::DrawingSheetBuilder* NXOpen::Features::ShipDesign::DrawingPartBuilder::CreateDrawingSheetBuilder ( NXOpen::Drawings::DrawingSheet drawingSheet)

Creates a NXOpen::Features::ShipDesign::DrawingSheetBuilder.

Returns

Created in NX12.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
Parameters
drawingSheetdrawingsheet
NXString NXOpen::Features::ShipDesign::DrawingPartBuilder::DrawingName ( )

Returns the drawing name
Created in NX12.0.0.



License requirements : None

NXOpen::Features::ShipDesign::DrawingSheetBuilderList* NXOpen::Features::ShipDesign::DrawingPartBuilder::DrawingSheetList ( )

Returns the drawing sheet list
Created in NX12.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::DrawingPartBuilder::SetDrawingName ( const NXString drawingName)

Sets the drawing name
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
drawingNamedrawingname
void NXOpen::Features::ShipDesign::DrawingPartBuilder::SetDrawingName ( const char *  drawingName)

Sets the drawing name
Created in NX12.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
drawingNamedrawingname
virtual bool NXOpen::Features::ShipDesign::DrawingPartBuilder::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.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.