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

Represents a collection of NXOpen::Annotations::FrameBar objects
To obtain an instance of this class, refer to NXOpen::Annotations::AnnotationManager

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Annotations::FrameBarCollection:
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::Annotations::AddTicBuilderCreateAddTicBuilder (NXOpen::Annotations::FrameBar *framebar)
 Creates a NXOpen::Annotations::AddTicBuilder. More...
 
NXOpen::Annotations::FrameBarBuilderCreateFrameBarBuilder (NXOpen::Annotations::FrameBar *framebar)
 If NULL create a new Frame bar, otherwise edit existing Frame bar Annotatation. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::Annotations::FrameBarFindObject (const NXString &journalIdentifier)
 Finds the frame bar with the given name. More...
 
NXOpen::Annotations::FrameBarFindObject (const char *journalIdentifier)
 Finds the frame bar with the given name. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen::Annotations::FrameBar objects
To obtain an instance of this class, refer to NXOpen::Annotations::AnnotationManager

Created in NX8.0.0.


Member Function Documentation

iterator NXOpen::Annotations::FrameBarCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::Annotations::AddTicBuilder* NXOpen::Annotations::FrameBarCollection::CreateAddTicBuilder ( NXOpen::Annotations::FrameBar framebar)

Creates a NXOpen::Annotations::AddTicBuilder.

Returns

Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
Parameters
framebarframe bar
NXOpen::Annotations::FrameBarBuilder* NXOpen::Annotations::FrameBarCollection::CreateFrameBarBuilder ( NXOpen::Annotations::FrameBar framebar)

If NULL create a new Frame bar, otherwise edit existing Frame bar Annotatation.

Returns

Created in NX8.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")
Parameters
framebarframe bar
iterator NXOpen::Annotations::FrameBarCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Annotations::FrameBar* NXOpen::Annotations::FrameBarCollection::FindObject ( const NXString journalIdentifier)

Finds the frame bar with the given name.

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

Returns
frame bar with this identifier
Created in NX8.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the frame bar to be found
NXOpen::Annotations::FrameBar* NXOpen::Annotations::FrameBarCollection::FindObject ( const char *  journalIdentifier)

Finds the frame bar with the given name.

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

Returns
frame bar with this identifier
Created in NX8.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier of the frame bar to be found
tag_t NXOpen::Annotations::FrameBarCollection::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.