Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

PmtMetadataIterator Class Reference

PmtMetadataIterator is provided for iterating over multiple metadata instances. More...

#include <PmtMetadata.h>

List of all members.

Public Types

typedef list< PmtMetadataPtr > PmtMetadataList

typedef PmtMetadataList::iterator PmtMdIter

Public Methods

PmtMetadataIterator ()

The default constructor. More...

PmtMetadataIterator (const PmtMetadataIterator &src)

The copy constructor. More...

~PmtMetadataIterator ()

The destructor. More...

PmtMetadataIterator & operator= (const PmtMetadataIterator &rhs)

The assignment operator. More...

PmtMetadataPtr start ()

This returns the beginning element of the iterator. More...

PmtMetadataPtr next ()

This returns the next element in the iterator. More...

int size ()

This returns the number of elements in the iterator. More...

void clear ()

This clears the interator. More...

void show (bool showObjectMemoryPointers=false)

This shows the metadata in the iterator. More...

PmtMetadataPtr checkIter (PmtMdIter &iter)

This checks the iterator. More...

void insert (PmtMetadataPtr &mdPtr)

This inserts a new metadata ptr into the metadata list. More...

Detailed Description

PmtMetadataIterator is provided for iterating over multiple metadata instances.

PmtMetadataIterator instances are returned from methods that need to return a reference to metadata instances. This is a fairly basic interator class. Internal pointers are reset with the start() method, which also return a reference to the first metadata instance. Additional references to metadata instances can be had by calling the next() method. The next() will return a NULL reference when the end of the list is reached.

Example usage:

  PmtMetadataIterator iter = rootMd->getMetadata( "*" ) ;
  PmtMetadataPtr child = iter.start() ;
  while( child != NULL )
  {
    // do something with child..

    // now get the next metadata instance
    child = iter.next() ;
  }

Member Typedef Documentation

typedef PmtMetadataList::iterator PmtMetadataIterator::PmtMdIter

typedef list<PmtMetadataPtr> PmtMetadataIterator::PmtMetadataList

Constructor & Destructor Documentation

PmtMetadataIterator::PmtMetadataIterator ( ) [inline]

The default constructor.

PmtMetadataIterator::PmtMetadataIterator ( const PmtMetadataIterator & src ) [inline]

The copy constructor.

PmtMetadataIterator::~PmtMetadataIterator ( ) [inline]

The destructor.

Member Function Documentation

PmtMetadataPtr PmtMetadataIterator::checkIter ( PmtMdIter & iter ) [inline]

This checks the iterator.

void PmtMetadataIterator::clear ( ) [inline]

This clears the interator.

void PmtMetadataIterator::insert ( PmtMetadataPtr & mdPtr ) [inline]

This inserts a new metadata ptr into the metadata list.

PmtMetadataPtr PmtMetadataIterator::next ( ) [inline]

This returns the next element in the iterator.

PmtMetadataIterator& PmtMetadataIterator::operator= ( const PmtMetadataIterator & rhs ) [inline]

The assignment operator.

void PmtMetadataIterator::show ( bool showObjectMemoryPointers = false )

This shows the metadata in the iterator.

int PmtMetadataIterator::size ( ) [inline]

This returns the number of elements in the iterator.

PmtMetadataPtr PmtMetadataIterator::start ( ) [inline]

This returns the beginning element of the iterator.

The documentation for this class was generated from the following files: