NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Classes | Public Member Functions | List of all members
NXOpen::Diagramming::TitleBlockCollection Class Reference

Represents a collection of Title Block. More...

Inheritance diagram for NXOpen::Diagramming::TitleBlockCollection:
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::Diagramming::DefineTitleBlockBuilderCreateDefineTitleBlockBuilder (NXOpen::Diagramming::TitleBlock *titleBlock)
 Creates a NXOpen::Diagramming::DefineTitleBlockBuilder . More...
 
NXOpen::Diagramming::PopulateTitleBlockBuilderCreatePopulateTitleBlockBuilder (const std::vector< NXOpen::Diagramming::TitleBlock * > &titleBlocks)
 Creates a NXOpen::Diagramming::PopulateTitleBlockBuilder . More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Diagramming::TitleBlockFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Diagramming::TitleBlock with the given identifier as recorded in a journal. More...
 
NXOpen::Diagramming::TitleBlockFindObject (const char *journalIdentifier)
 Finds the NXOpen::Diagramming::TitleBlock with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of Title Block.


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

Created in NX11.0.1.

Member Function Documentation

iterator NXOpen::Diagramming::TitleBlockCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Diagramming::DefineTitleBlockBuilder* NXOpen::Diagramming::TitleBlockCollection::CreateDefineTitleBlockBuilder ( NXOpen::Diagramming::TitleBlock titleBlock)

Creates a NXOpen::Diagramming::DefineTitleBlockBuilder .


Created in NX11.0.1.

License requirements : None

Parameters
titleBlockNXOpen::Diagramming::TitleBlock to be edited, if NULL then create a new one
NXOpen::Diagramming::PopulateTitleBlockBuilder* NXOpen::Diagramming::TitleBlockCollection::CreatePopulateTitleBlockBuilder ( const std::vector< NXOpen::Diagramming::TitleBlock * > &  titleBlocks)

Creates a NXOpen::Diagramming::PopulateTitleBlockBuilder .


Created in NX11.0.1.

License requirements : None

Parameters
titleBlockstitleblocks
iterator NXOpen::Diagramming::TitleBlockCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Diagramming::TitleBlock* NXOpen::Diagramming::TitleBlockCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Diagramming::TitleBlock with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with given name.

Returns
NXOpen::Diagramming::TitleBlock with this name.
Created in NX11.0.1.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::Diagramming::TitleBlock* NXOpen::Diagramming::TitleBlockCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Diagramming::TitleBlock with the given identifier as recorded in a journal.

An exception will be thrown if no object can be found with given name.

Returns
NXOpen::Diagramming::TitleBlock with this name.
Created in NX11.0.1.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
tag_t NXOpen::Diagramming::TitleBlockCollection::Tag ( ) const

Returns the tag of this object.


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