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

Represents a collection of NXOpen::Layout2d::LayoutDrawingSheet s. More...

Inheritance diagram for NXOpen::Layout2d::LayoutDrawingSheetCollection:
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::Layout2d::ConvertLayoutToSheetBuilderCreateConvertLayoutToSheetBuilder ()
 Creates a NXOpen::Layout2d::ConvertLayoutToSheetBuilder. More...
 
NXOpen::Layout2d::ConvertSheetToLayoutBuilderCreateConvertSheetToLayoutBuilder ()
 Creates a NXOpen::Layout2d::ConvertSheetToLayoutBuilder. More...
 
NXOpen::Layout2d::LayoutDrawingSheetBuilderCreateLayoutDrawingSheetBuilder (NXOpen::Layout2d::LayoutDrawingSheet *layoutDrawingSheet)
 Creates a NXOpen::Layout2d::LayoutDrawingSheetBuilder. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Layout2d::LayoutDrawingSheetFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Layout2d::LayoutDrawingSheet with the given identifier as recorded in a journal. More...
 
NXOpen::Layout2d::LayoutDrawingSheetFindObject (const char *journalIdentifier)
 Finds the NXOpen::Layout2d::LayoutDrawingSheet with the given identifier as recorded in a journal. More...
 
NXOpen::Layout2d::LayoutDrawingSheetInsertSheet (const NXString &name, NXOpen::Drawings::DrawingSheet::Unit units, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
 Inserts a layout drawing sheet into a part. More...
 
NXOpen::Layout2d::LayoutDrawingSheetInsertSheet (const char *name, NXOpen::Drawings::DrawingSheet::Unit units, double numerator, double denominator, NXOpen::Drawings::DrawingSheet::ProjectionAngleType projectionAngle)
 Inserts a layout drawing sheet into a part. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Layout2d::LayoutDrawingSheet s.


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

Created in NX12.0.0.

Member Function Documentation

iterator NXOpen::Layout2d::LayoutDrawingSheetCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Layout2d::ConvertLayoutToSheetBuilder* NXOpen::Layout2d::LayoutDrawingSheetCollection::CreateConvertLayoutToSheetBuilder ( )

Creates a NXOpen::Layout2d::ConvertLayoutToSheetBuilder.

Returns
the convert layout to sheet builder
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::ConvertSheetToLayoutBuilder* NXOpen::Layout2d::LayoutDrawingSheetCollection::CreateConvertSheetToLayoutBuilder ( )

Creates a NXOpen::Layout2d::ConvertSheetToLayoutBuilder.

Returns
the convert sheet to layout builder
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")
NXOpen::Layout2d::LayoutDrawingSheetBuilder* NXOpen::Layout2d::LayoutDrawingSheetCollection::CreateLayoutDrawingSheetBuilder ( NXOpen::Layout2d::LayoutDrawingSheet layoutDrawingSheet)

Creates a NXOpen::Layout2d::LayoutDrawingSheetBuilder.

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

License requirements : nx_layout ("NX Layout")
Parameters
layoutDrawingSheetreserved for future use, set to 0
iterator NXOpen::Layout2d::LayoutDrawingSheetCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Layout2d::LayoutDrawingSheet* NXOpen::Layout2d::LayoutDrawingSheetCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Layout2d::LayoutDrawingSheet 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
Layout drawing sheet with this identifier
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
journalIdentifierIdentifier of the Layout drawing sheet you want
NXOpen::Layout2d::LayoutDrawingSheet* NXOpen::Layout2d::LayoutDrawingSheetCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Layout2d::LayoutDrawingSheet 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
Layout drawing sheet with this identifier
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
journalIdentifierIdentifier of the Layout drawing sheet you want
NXOpen::Layout2d::LayoutDrawingSheet* NXOpen::Layout2d::LayoutDrawingSheetCollection::InsertSheet ( const NXString name,
NXOpen::Drawings::DrawingSheet::Unit  units,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle 
)

Inserts a layout drawing sheet into a part.

Returns
the inserted layout drawing sheet
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
nameLayout drawing sheet name
unitsUnit of sheet size
numeratorNumerator of the scale of layout
denominatorDenominator of the scale of layout
projectionAngleProjection angle
NXOpen::Layout2d::LayoutDrawingSheet* NXOpen::Layout2d::LayoutDrawingSheetCollection::InsertSheet ( const char *  name,
NXOpen::Drawings::DrawingSheet::Unit  units,
double  numerator,
double  denominator,
NXOpen::Drawings::DrawingSheet::ProjectionAngleType  projectionAngle 
)

Inserts a layout drawing sheet into a part.

Returns
the inserted layout drawing sheet
Created in NX12.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
nameLayout drawing sheet name
unitsUnit of sheet size
numeratorNumerator of the scale of layout
denominatorDenominator of the scale of layout
projectionAngleProjection angle
tag_t NXOpen::Layout2d::LayoutDrawingSheetCollection::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.