OSB_LIB::TcsVersions Struct Reference

Collaboration diagram for OSB_LIB::TcsVersions:

[legend]List of all members.

---

Detailed Description

Container for a list of tariff classification system version.

The class TcsVersion is an abstract base class. Thus we have to use pointers to tariff classification system version in the list and not the objects themselves. The structure is a wrapper to an STL container that takes care on correct object destruction.

Definition at line 781 of file tariffclass.h.

Public Types

STL container type definition.

• typedef std::list< TcsVersion * > List
• typedef List::iterator Iterator

  STL iterator.
  

• typedef List::const_iterator ConstIterator

  STL const_iterator.
  

• typedef List::size_type SizeType

  STL constainer size_type.
  

Public Member Functions

• TcsVersions ()

  Empty constructor.
  

• TcsVersions (const TcsVersions &rhs)

  Copy constructor.
  

• TcsVersions & operator= (const TcsVersions &rhs)

  Exception save assignment operator.
  

• ~TcsVersions ()

  Delete all stored objects.
  

• void pushBack (const TcsVersion &tcsVs)

  Insert a new tariff classification system version.
  

• void pushBack (TcsVersion::AutoPtr tcsVs)

  Insert a new tariff classification system version.
  

• void erase (const TcsVersion::Oid &tcsVs)

  Erase a tariff classification system version 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

  Constant iterator to the begining of the list.
  

• ConstIterator end () const

  Constant iterator to the end of the list.
  

• SizeType size () const

  The size of the list.
  

• void swap (TcsVersions &rhs)

  Swap the content of two lists.
  

Public Attributes

• List list_

  STL container for tariff classification system versions.
  

---

Member Typedef Documentation

typedef List::const_iterator OSB_LIB::TcsVersions::ConstIterator

STL const_iterator.

Definition at line 791 of file tariffclass.h.

typedef List::iterator OSB_LIB::TcsVersions::Iterator

STL iterator.

Definition at line 789 of file tariffclass.h.

typedef std::list<TcsVersion*> OSB_LIB::TcsVersions::List

Define a list of tariff classification system version pointer as List.

Definition at line 787 of file tariffclass.h.

typedef List::size_type OSB_LIB::TcsVersions::SizeType

STL constainer size_type.

Definition at line 793 of file tariffclass.h.

---

Constructor & Destructor Documentation

OSB_LIB::TcsVersions::TcsVersions

(

)

Empty constructor.

OSB_LIB::TcsVersions::TcsVersions

(

const TcsVersions &

rhs

)

Copy constructor.

Creates (allocates) a copy of every tariff classification system version in the STL container.

OSB_LIB::TcsVersions::~TcsVersions

(

)

Delete all stored objects.

---

Member Function Documentation

ConstIterator OSB_LIB::TcsVersions::begin

(

)

const

Constant iterator to the begining of the list.

Iterator OSB_LIB::TcsVersions::begin

(

)

Iterator to the begining of the list.

void OSB_LIB::TcsVersions::clear

(

)

Clear the list.

Destruct each item in the list and afterwards, call the std::list::clear() of the STL constainer.

ConstIterator OSB_LIB::TcsVersions::end

(

)

const

Constant iterator to the end of the list.

Iterator OSB_LIB::TcsVersions::end

(

)

Iterator to the end of the list.

void OSB_LIB::TcsVersions::erase

(

const TcsVersion::Oid &

tcsVs

)

Erase a tariff classification system version from the list.

Remove a tariff classification system version from the list and call its destructor.

Parameters:

tcsVs

Iterator to the tariff classification system version in the list.

TcsVersions& OSB_LIB::TcsVersions::operator=

(

const TcsVersions &

rhs

)

Exception save assignment operator.

void OSB_LIB::TcsVersions::pushBack

(

TcsVersion::AutoPtr

tcsVs

)

Insert a new tariff classification system version.

Add a tariff classification system version at the end of the list. The function take over the ownership of the tariff classification system version object from the auto pointer passed in parameter argument.

Parameters:

tcsVs

Auto pointer of tariff classification system version to be added.

void OSB_LIB::TcsVersions::pushBack

(

const TcsVersion &

tcsVs

)

Insert a new tariff classification system version.

Add a tariff classification system version object at the end of the list. The function uses TcsVersion::clone() to create a copy of the tariff classification system version.

Parameters:

tcsVs

Tariff classification system version to be added.

SizeType OSB_LIB::TcsVersions::size

(

)

const

The size of the list.

void OSB_LIB::TcsVersions::swap

(

TcsVersions &

rhs

)

Swap the content of two lists.

---

Member Data Documentation

List OSB_LIB::TcsVersions::list_

STL container for tariff classification system versions.

Definition at line 875 of file tariffclass.h.

---

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

• tariffclass.h

---