OSB_LIB::NumberAnalyzerList Struct Reference

Collaboration diagram for OSB_LIB::NumberAnalyzerList:

[legend]List of all members.

---

Detailed Description

Container for a list of number analyzer objects.

NumberAnalyzer is an abstract base class. STL container cannot store them directly. This structure is a wrapper to an STL container that stores the pointers to those abstract base classes and take care on the correct object destruction.

Definition at line 322 of file numberanalyzer.h.

Public Types

STL container type definition.

• typedef std::list< NumberAnalyzer * > List

  Define a list of number analyzer pointer as List.
  

• typedef List::iterator Iterator

  STL iterator.
  

• typedef List::const_iterator ConstIterator

  STL const_iterator.
  

• typedef List::size_type SizeType

  STL container size_type.
  

Public Member Functions

• NumberAnalyzerList ()

  Empty constructor.
  

• NumberAnalyzerList (const NumberAnalyzerList &rhs)

  Copy constructor.
  

• NumberAnalyzerList & operator= (const NumberAnalyzerList &rhs)

  Exception save assignment operator.
  

• ~NumberAnalyzerList ()

  Delete all stored objects.
  

• void push_back (const NumberAnalyzer &numAnalyzer)

  Add a new number analyzer object to the back of the internal list.
  

• void push_back (NumberAnalyzer::AutoPtr naPtr)

  Add a new number analyzer object to the back of the internal list.
  

• Iterator erase (Iterator pos)

  Erase a number analyzer object from the list.
  

• void clear ()

  Clear the list.
  

STL container wrappers.

Remarks:

Do not add an STL operation to this group if the function does more than just wrapping! All functions return the STL operations on items.

• Iterator begin ()

  Iterator to the begining of the list.
  

• Iterator end ()

  Iterator to the end of the list.
  

• ConstIterator begin () const

  Const iterator to the begining of the list.
  

• ConstIterator end () const

  Const iterator to the end of the list.
  

• SizeType size () const

  The size of the list.
  

• void swap (NumberAnalyzerList &rhs)

  Swap the content of two lists.
  

Public Attributes

• List items

  STL container for number analyzers.
  

---

Member Typedef Documentation

typedef List::const_iterator OSB_LIB::NumberAnalyzerList::ConstIterator

STL const_iterator.

Definition at line 330 of file numberanalyzer.h.

typedef List::iterator OSB_LIB::NumberAnalyzerList::Iterator

STL iterator.

Definition at line 328 of file numberanalyzer.h.

typedef std::list<NumberAnalyzer*> OSB_LIB::NumberAnalyzerList::List

Define a list of number analyzer pointer as List.

Definition at line 326 of file numberanalyzer.h.

typedef List::size_type OSB_LIB::NumberAnalyzerList::SizeType

STL container size_type.

Definition at line 332 of file numberanalyzer.h.

---

Constructor & Destructor Documentation

OSB_LIB::NumberAnalyzerList::NumberAnalyzerList

(

)

[inline]

Empty constructor.

Definition at line 339 of file numberanalyzer.h.

OSB_LIB::NumberAnalyzerList::NumberAnalyzerList

(

const NumberAnalyzerList &

rhs

)

Copy constructor.

Creates (allocates) a copy of every number analyzer in the STL container.

OSB_LIB::NumberAnalyzerList::~NumberAnalyzerList

(

)

Delete all stored objects.

---

Member Function Documentation

ConstIterator OSB_LIB::NumberAnalyzerList::begin

(

)

const

Const iterator to the begining of the list.

Iterator OSB_LIB::NumberAnalyzerList::begin

(

)

Iterator to the begining of the list.

void OSB_LIB::NumberAnalyzerList::clear

(

)

Clear the list.

Destructs each item in the list and afterwards calls clear() of the STL container.

ConstIterator OSB_LIB::NumberAnalyzerList::end

(

)

const

Const iterator to the end of the list.

Iterator OSB_LIB::NumberAnalyzerList::end

(

)

Iterator to the end of the list.

Iterator OSB_LIB::NumberAnalyzerList::erase

(

Iterator

pos

)

Erase a number analyzer object from the list.

Removes a number analyzer object from the internal list and calls its destructor.

Parameters:

pos

Iterator to the number analyzer to be removed.

Returns:

An iterator that points to the next number number analyzer in the list.

NumberAnalyzerList& OSB_LIB::NumberAnalyzerList::operator=

(

const NumberAnalyzerList &

rhs

)

Exception save assignment operator.

void OSB_LIB::NumberAnalyzerList::push_back

(

NumberAnalyzer::AutoPtr

naPtr

)

Add a new number analyzer object to the back of the internal list.

The function get the ownership of the number analyzer auto pointer passed in, and add it to the end of the internal list.

Parameters:

naPtr

Auto pointer of the number analyzer object to be added.

void OSB_LIB::NumberAnalyzerList::push_back

(

const NumberAnalyzer &

numAnalyzer

)

Add a new number analyzer object to the back of the internal list.

The function uses NumberAnalyzer::clone() to create a copy of the number analyzer object then add it to the end of the list.

Parameters:

numAnalyzer

Number analyzer to be added.

SizeType OSB_LIB::NumberAnalyzerList::size

(

)

const

The size of the list.

void OSB_LIB::NumberAnalyzerList::swap

(

NumberAnalyzerList &

rhs

)

Swap the content of two lists.

---

Member Data Documentation

List OSB_LIB::NumberAnalyzerList::items

STL container for number analyzers.

Definition at line 336 of file numberanalyzer.h.

---

The documentation for this struct was generated from the following file:

• numberanalyzer.h

---