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

Represents a collection of Shape. More...

Inheritance diagram for NXOpen::Diagramming::ShapeCollection:
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::ShapeBuilderCreateShapeBuilder (NXOpen::Diagramming::Shape *shape)
 Creates a NXOpen::Diagramming::ShapeBuilder . More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Diagramming::ShapeFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Diagramming::Shape with the given identifier as recorded in a journal. More...
 
NXOpen::Diagramming::ShapeFindObject (const char *journalIdentifier)
 Finds the NXOpen::Diagramming::Shape 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 Shape.


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

Created in NX10.0.0.

Member Function Documentation

iterator NXOpen::Diagramming::ShapeCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Diagramming::ShapeBuilder* NXOpen::Diagramming::ShapeCollection::CreateShapeBuilder ( NXOpen::Diagramming::Shape shape)

Creates a NXOpen::Diagramming::ShapeBuilder .

Returns

Created in NX10.0.0.

License requirements : None
Parameters
shapeNXOpen::Diagramming::Shape to be edited, if NULL then create a new one
iterator NXOpen::Diagramming::ShapeCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Diagramming::Shape* NXOpen::Diagramming::ShapeCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Diagramming::Shape 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::Shape with this name.
Created in NX10.0.0.

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

Finds the NXOpen::Diagramming::Shape 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::Shape with this name.
Created in NX10.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
tag_t NXOpen::Diagramming::ShapeCollection::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.