NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Layout2d::ConvertLayoutToSheetBuilder Class Reference

Represents a Builder for converting Layout to drawing sheet
To create a new instance of this class, use NXOpen::Layout2d::LayoutDrawingSheetCollection::CreateConvertLayoutToSheetBuilder

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::Layout2d::ConvertLayoutToSheetBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SheetProjectionAngleType { SheetProjectionAngleTypeFirst, SheetProjectionAngleTypeThird }
 the drawing sheet projection angle More...
 

Public Member Functions

void GetScale (double *numerator, double *denominator)
 Gets the sheet scale
Created in NX12.0.0. More...
 
NXString Name ()
 Returns the name of the drawing sheet to be created
Created in NX12.0.0. More...
 
NXString Number ()
 Returns the number of the drawing sheet to be created
Created in NX12.0.0. More...
 
NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SheetProjectionAngleType ProjectionAngleType ()
 Returns the sheet projection angle option
Created in NX12.0.0. More...
 
NXString Revision ()
 Returns the revision of the drawing sheet to be created
Created in NX12.0.0. More...
 
NXString SecondaryNumber ()
 Returns the secondary number of the drawing sheet to be created
Created in NX12.0.0. More...
 
NXOpen::SelectViewSelectLayoutSheetView ()
 Returns the select layout sheet view to convert
Created in NX12.0.0. More...
 
void SetName (const NXString &name)
 Sets the name of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetName (const char *name)
 Sets the name of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetNumber (const NXString &number)
 Sets the number of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetNumber (const char *number)
 Sets the number of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetProjectionAngleType (NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SheetProjectionAngleType type)
 Sets the sheet projection angle option
Created in NX12.0.0. More...
 
void SetRevision (const NXString &revision)
 Sets the revision of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetRevision (const char *revision)
 Sets the revision of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetScale (double numerator, double denominator)
 Sets the sheet scale
Created in NX12.0.0. More...
 
void SetSecondaryNumber (const NXString &secondaryNumber)
 Sets the secondary number of the drawing sheet to be created
Created in NX12.0.0. More...
 
void SetSecondaryNumber (const char *secondaryNumber)
 Sets the secondary number of the drawing sheet to be created
Created in NX12.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 Builder for converting Layout to drawing sheet
To create a new instance of this class, use NXOpen::Layout2d::LayoutDrawingSheetCollection::CreateConvertLayoutToSheetBuilder

Created in NX12.0.0.


Member Enumeration Documentation

the drawing sheet projection angle

Enumerator
SheetProjectionAngleTypeFirst 

first angle projection

SheetProjectionAngleTypeThird 

third angle projection

Member Function Documentation

void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::GetScale ( double *  numerator,
double *  denominator 
)

Gets the sheet scale
Created in NX12.0.0.



License requirements : None

Parameters
numeratorthe scale numerator
denominatorthe scale denominator
NXString NXOpen::Layout2d::ConvertLayoutToSheetBuilder::Name ( )

Returns the name of the drawing sheet to be created
Created in NX12.0.0.



License requirements : None

NXString NXOpen::Layout2d::ConvertLayoutToSheetBuilder::Number ( )

Returns the number of the drawing sheet to be created
Created in NX12.0.0.



License requirements : None

NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SheetProjectionAngleType NXOpen::Layout2d::ConvertLayoutToSheetBuilder::ProjectionAngleType ( )

Returns the sheet projection angle option
Created in NX12.0.0.



License requirements : None

NXString NXOpen::Layout2d::ConvertLayoutToSheetBuilder::Revision ( )

Returns the revision of the drawing sheet to be created
Created in NX12.0.0.



License requirements : None

NXString NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SecondaryNumber ( )

Returns the secondary number of the drawing sheet to be created
Created in NX12.0.0.



License requirements : None

NXOpen::SelectView* NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SelectLayoutSheetView ( )

Returns the select layout sheet view to convert
Created in NX12.0.0.



License requirements : None

void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetName ( const NXString name)

Sets the name of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
namedrawing sheet name
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetName ( const char *  name)

Sets the name of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
namedrawing sheet name
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetNumber ( const NXString number)

Sets the number of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
numberthe drawing sheet number
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetNumber ( const char *  number)

Sets the number of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
numberthe drawing sheet number
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetProjectionAngleType ( NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SheetProjectionAngleType  type)

Sets the sheet projection angle option
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
typethe projection angle type
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetRevision ( const NXString revision)

Sets the revision of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
revisionthe drawing sheet revision
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetRevision ( const char *  revision)

Sets the revision of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
revisionthe drawing sheet revision
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetScale ( double  numerator,
double  denominator 
)

Sets the sheet scale
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
numeratorthe scale numerator
denominatorthe scale denominator
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetSecondaryNumber ( const NXString secondaryNumber)

Sets the secondary number of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
secondaryNumberthe drawing sheet secondary number
void NXOpen::Layout2d::ConvertLayoutToSheetBuilder::SetSecondaryNumber ( const char *  secondaryNumber)

Sets the secondary number of the drawing sheet to be created
Created in NX12.0.0.



License requirements : nx_layout ("NX Layout")

Parameters
secondaryNumberthe drawing sheet secondary number

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