NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::Drawings::DraftingDrawingSheetCollection Class Reference

Represents a collection of NXOpen::Drawings::DraftingDrawingSheet s. More...

Inheritance diagram for NXOpen::Drawings::DraftingDrawingSheetCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::Drawings::DraftingDrawingSheetBuilderCreateDraftingDrawingSheetBuilder (NXOpen::Drawings::DraftingDrawingSheet *draftingDrawingSheet)
 Creates a NXOpen::Drawings::DraftingDrawingSheetBuilder. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Drawings::DraftingDrawingSheetFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Drawings::DraftingDrawingSheet with the given identifier as recorded in a journal. More...
 
NXOpen::Drawings::DraftingDrawingSheetFindObject (const char *journalIdentifier)
 Finds the NXOpen::Drawings::DraftingDrawingSheet with the given identifier as recorded in a journal. More...
 
NXOpen::Drawings::DrawingSheetInsertSheet (const NXString &drawingName, NXOpen::Drawings::DrawingSheet::Unit drawingUnits, double width, double height, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
 Inserts a drafting drawing sheet into a part. More...
 
NXOpen::Drawings::DrawingSheetInsertSheet (const char *drawingName, NXOpen::Drawings::DrawingSheet::Unit drawingUnits, double width, double height, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
 Inserts a drafting drawing sheet into a part. More...
 
NXOpen::Drawings::DrawingSheetInsertSheet (const NXString &drawingName, NXOpen::Drawings::DrawingSheet::StandardSheetSize sheetSize, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
 Inserts a sheet into a part. More...
 
NXOpen::Drawings::DrawingSheetInsertSheet (const char *drawingName, NXOpen::Drawings::DrawingSheet::StandardSheetSize sheetSize, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
 Inserts a sheet into a part. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Drawings::DraftingDrawingSheet s.


To obtain an instance of this class, refer to NXOpen::Part

Created in NX12.0.0.

Member Function Documentation

iterator NXOpen::Drawings::DraftingDrawingSheetCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Drawings::DraftingDrawingSheetBuilder* NXOpen::Drawings::DraftingDrawingSheetCollection::CreateDraftingDrawingSheetBuilder ( NXOpen::Drawings::DraftingDrawingSheet draftingDrawingSheet)

Creates a NXOpen::Drawings::DraftingDrawingSheetBuilder.

Returns
the drafting drawing sheet builder
Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
draftingDrawingSheetreserved for future use, set to 0
iterator NXOpen::Drawings::DraftingDrawingSheetCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Drawings::DraftingDrawingSheet* NXOpen::Drawings::DraftingDrawingSheetCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Drawings::DraftingDrawingSheet with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Drafting drawing sheet with this identifier
Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
journalIdentifierIdentifier of the Drafting drawing sheet you want
NXOpen::Drawings::DraftingDrawingSheet* NXOpen::Drawings::DraftingDrawingSheetCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Drawings::DraftingDrawingSheet with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Drafting drawing sheet with this identifier
Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
journalIdentifierIdentifier of the Drafting drawing sheet you want
NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DraftingDrawingSheetCollection::InsertSheet ( const NXString drawingName,
NXOpen::Drawings::DrawingSheet::Unit  drawingUnits,
double  width,
double  height,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle 
)

Inserts a drafting drawing sheet into a part.

Returns

Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
drawingNameDrawing name
drawingUnitsUnit of sheet size
widthWidth of drawing
heightHeight of drawing
numeratorNumerator of the scale of drawing
denominatorDenominator of the scale of drawing
projectionAngleProjection angle
NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DraftingDrawingSheetCollection::InsertSheet ( const char *  drawingName,
NXOpen::Drawings::DrawingSheet::Unit  drawingUnits,
double  width,
double  height,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle 
)

Inserts a drafting drawing sheet into a part.

Returns

Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
drawingNameDrawing name
drawingUnitsUnit of sheet size
widthWidth of drawing
heightHeight of drawing
numeratorNumerator of the scale of drawing
denominatorDenominator of the scale of drawing
projectionAngleProjection angle
NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DraftingDrawingSheetCollection::InsertSheet ( const NXString drawingName,
NXOpen::Drawings::DrawingSheet::StandardSheetSize  sheetSize,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle 
)

Inserts a sheet into a part.

The drawings units will be inferred from the standard size.

Returns

Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
drawingNameDrawing name
sheetSizeSheet Size
numeratorNumerator of the scale of drawing
denominatorDenominator of the scale of drawing
projectionAngleProjection angle
NXOpen::Drawings::DrawingSheet* NXOpen::Drawings::DraftingDrawingSheetCollection::InsertSheet ( const char *  drawingName,
NXOpen::Drawings::DrawingSheet::StandardSheetSize  sheetSize,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle 
)

Inserts a sheet into a part.

The drawings units will be inferred from the standard size.

Returns

Created in NX12.0.0.

License requirements : drafting ("DRAFTING")
Parameters
drawingNameDrawing name
sheetSizeSheet Size
numeratorNumerator of the scale of drawing
denominatorDenominator of the scale of drawing
projectionAngleProjection angle
tag_t NXOpen::Drawings::DraftingDrawingSheetCollection::Tag ( ) const

Returns the tag of this object.


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