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

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

Inheritance diagram for NXOpen::Features::ShipDesign::ExpansionDrawingBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  JaExpansiondrawingbuilderEnglishScale {
  JaExpansiondrawingbuilderEnglishScaleS81, JaExpansiondrawingbuilderEnglishScaleS41, JaExpansiondrawingbuilderEnglishScaleS21, JaExpansiondrawingbuilderEnglishScaleS11,
  JaExpansiondrawingbuilderEnglishScaleS12, JaExpansiondrawingbuilderEnglishScaleS14, JaExpansiondrawingbuilderEnglishScaleS18, JaExpansiondrawingbuilderEnglishScaleCustom,
  JaExpansiondrawingbuilderEnglishScaleDefault
}
 the standard English drawing sheet scales More...
 
enum  JaExpansiondrawingbuilderMetricScale {
  JaExpansiondrawingbuilderMetricScaleS501, JaExpansiondrawingbuilderMetricScaleS201, JaExpansiondrawingbuilderMetricScaleS101, JaExpansiondrawingbuilderMetricScaleS51,
  JaExpansiondrawingbuilderMetricScaleS21, JaExpansiondrawingbuilderMetricScaleS11, JaExpansiondrawingbuilderMetricScaleS12, JaExpansiondrawingbuilderMetricScaleS15,
  JaExpansiondrawingbuilderMetricScaleS110, JaExpansiondrawingbuilderMetricScaleS120, JaExpansiondrawingbuilderMetricScaleS150, JaExpansiondrawingbuilderMetricScaleS1100,
  JaExpansiondrawingbuilderMetricScaleCustom, JaExpansiondrawingbuilderMetricScaleDefault
}
 the standard Metric drawing sheet scales More...
 

Public Member Functions

NXOpen::PlaneAftPlane ()
 Returns the aft plane
Created in NX10.0.0. More...
 
NXOpen::PlaneBasePlane ()
 Returns the base plane
Created in NX10.0.0. More...
 
bool BasicDesignMode ()
 Returns the basic design application flag
Created in NX11.0.0. More...
 
NXOpen::Features::ShipDesign::DrawingTemplateBuilderDrawingTemplate ()
 Returns the drawing template
Created in NX10.0.0. More...
 
NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderEnglishScale EnglishScale ()
 Returns the English drawing scale
Created in NX11.0.0. More...
 
NXOpen::PlaneForePlane ()
 Returns the fore plane
Created in NX10.0.0. More...
 
bool IsEdit ()
 Returns the flag to indicate to either create or edit a Ship Expansion View. More...
 
NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderMetricScale MetricScale ()
 Returns the Metric drawing scale
Created in NX11.0.0. More...
 
NXOpen::SelectNXObjectListPlatesToExpand ()
 Returns the plates to be expanded
Created in NX10.0.0. More...
 
double ScaleDenominator ()
 Returns the denominator of a custom scale
Created in NX11.0.0. More...
 
double ScaleNumerator ()
 Returns the numerator of a custom scale
Created in NX11.0.0. More...
 
void SetAftPlane (NXOpen::Plane *aftPlane)
 Sets the aft plane
Created in NX10.0.0. More...
 
void SetBasePlane (NXOpen::Plane *basePlane)
 Sets the base plane
Created in NX10.0.0. More...
 
void SetBasicDesignMode (bool isBasic)
 Sets the basic design application flag
Created in NX11.0.0. More...
 
void SetEdit (bool isEdit)
 Sets the flag to indicate to either create or edit a Ship Expansion View. More...
 
void SetEnglishScale (NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderEnglishScale englishScale)
 Sets the English drawing scale
Created in NX11.0.0. More...
 
void SetForePlane (NXOpen::Plane *forePlane)
 Sets the fore plane
Created in NX10.0.0. More...
 
void SetMetricScale (NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderMetricScale metricScale)
 Sets the Metric drawing scale
Created in NX11.0.0. More...
 
void SetScaleDenominator (double scaleDenominator)
 Sets the denominator of a custom scale
Created in NX11.0.0. More...
 
void SetScaleNumerator (double scaleNumerator)
 Sets the numerator of a custom scale
Created in NX11.0.0. More...
 
void SetTolerance (double tolerance)
 Sets the tolerance
Created in NX10.0.0. More...
 
void SetUpperPlane (NXOpen::Plane *upperPlane)
 Sets the upper plane
Created in NX10.0.0. More...
 
double Tolerance ()
 Returns the tolerance
Created in NX10.0.0. More...
 
NXOpen::PlaneUpperPlane ()
 Returns the upper plane
Created in NX10.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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::ExpansionDrawingBuilder .

This class is used to create expansion drawing and just returns NULL
To create a new instance of this class, use NXOpen::Features::ShipCollection::CreateExpansionDrawingBuilder

Created in NX10.0.0.

Member Enumeration Documentation

the standard English drawing sheet scales

Enumerator
JaExpansiondrawingbuilderEnglishScaleS81 

a scale of 8:1

JaExpansiondrawingbuilderEnglishScaleS41 

a scale of 4:1

JaExpansiondrawingbuilderEnglishScaleS21 

a scale of 2:1

JaExpansiondrawingbuilderEnglishScaleS11 

a scale of 1:1

JaExpansiondrawingbuilderEnglishScaleS12 

a scale of 1:2

JaExpansiondrawingbuilderEnglishScaleS14 

a scale of 1:4

JaExpansiondrawingbuilderEnglishScaleS18 

a scale of 1:8

JaExpansiondrawingbuilderEnglishScaleCustom 

a custom scale

JaExpansiondrawingbuilderEnglishScaleDefault 

default scale

the standard Metric drawing sheet scales

Enumerator
JaExpansiondrawingbuilderMetricScaleS501 

a scale of 50:1

JaExpansiondrawingbuilderMetricScaleS201 

a scale of 20:1

JaExpansiondrawingbuilderMetricScaleS101 

a scale of 10:1

JaExpansiondrawingbuilderMetricScaleS51 

a scale of 5:1

JaExpansiondrawingbuilderMetricScaleS21 

a scale of 2:1

JaExpansiondrawingbuilderMetricScaleS11 

a scale of 1:1

JaExpansiondrawingbuilderMetricScaleS12 

a scale of 1:2

JaExpansiondrawingbuilderMetricScaleS15 

a scale of 1:5

JaExpansiondrawingbuilderMetricScaleS110 

a scale of 1:10

JaExpansiondrawingbuilderMetricScaleS120 

a scale of 1:20

JaExpansiondrawingbuilderMetricScaleS150 

a scale of 1:50

JaExpansiondrawingbuilderMetricScaleS1100 

a scale of 1:100

JaExpansiondrawingbuilderMetricScaleCustom 

a custom scale

JaExpansiondrawingbuilderMetricScaleDefault 

default scale

Member Function Documentation

NXOpen::Plane* NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::AftPlane ( )

Returns the aft plane
Created in NX10.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::BasePlane ( )

Returns the base plane
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::BasicDesignMode ( )

Returns the basic design application flag
Created in NX11.0.0.



License requirements : None

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

Returns the drawing template
Created in NX10.0.0.



License requirements : None

NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderEnglishScale NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::EnglishScale ( )

Returns the English drawing scale
Created in NX11.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::ForePlane ( )

Returns the fore plane
Created in NX10.0.0.



License requirements : None

bool NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::IsEdit ( )

Returns the flag to indicate to either create or edit a Ship Expansion View.


Created in NX11.0.0.

License requirements : None

NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderMetricScale NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::MetricScale ( )

Returns the Metric drawing scale
Created in NX11.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::PlatesToExpand ( )

Returns the plates to be expanded
Created in NX10.0.0.



License requirements : None

double NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::ScaleDenominator ( )

Returns the denominator of a custom scale
Created in NX11.0.0.



License requirements : None

double NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::ScaleNumerator ( )

Returns the numerator of a custom scale
Created in NX11.0.0.



License requirements : None

void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetAftPlane ( NXOpen::Plane aftPlane)

Sets the aft plane
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
aftPlaneaftplane
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetBasePlane ( NXOpen::Plane basePlane)

Sets the base plane
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
basePlanebaseplane
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetBasicDesignMode ( bool  isBasic)

Sets the basic design application flag
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
isBasicisbasic
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetEdit ( bool  isEdit)

Sets the flag to indicate to either create or edit a Ship Expansion View.


Created in NX11.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
isEditisedit
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetEnglishScale ( NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderEnglishScale  englishScale)

Sets the English drawing scale
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
englishScalethe English drawing scale
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetForePlane ( NXOpen::Plane forePlane)

Sets the fore plane
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
forePlaneforeplane
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetMetricScale ( NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::JaExpansiondrawingbuilderMetricScale  metricScale)

Sets the Metric drawing scale
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
metricScalethe Metric drawing scale
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetScaleDenominator ( double  scaleDenominator)

Sets the denominator of a custom scale
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
scaleDenominatorthe denominator of a custom scale
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetScaleNumerator ( double  scaleNumerator)

Sets the numerator of a custom scale
Created in NX11.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
scaleNumeratorscale numerator
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetTolerance ( double  tolerance)

Sets the tolerance
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
tolerancetolerance
void NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::SetUpperPlane ( NXOpen::Plane upperPlane)

Sets the upper plane
Created in NX10.0.0.



License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
upperPlaneupperplane
double NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::Tolerance ( )

Returns the tolerance
Created in NX10.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Features::ShipDesign::ExpansionDrawingBuilder::UpperPlane ( )

Returns the upper plane
Created in NX10.0.0.



License requirements : None


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