OSB_LIB::SumCdrList Class Reference

Inheritance diagram for OSB_LIB::SumCdrList:

[legend]Collaboration diagram for OSB_LIB::SumCdrList:

[legend]List of all members.

---

Detailed Description

This object is responsible to handle summary call details records.

This SumCdrList class is responsible for fetching, updating and removing the list of summary cdrs to the database. It contains a list of pointers to the base class, SumCdr.

Definition at line 356 of file sumcdr.h.

Public Types

• typedef std::list< SumCdr * > List

  Container for a list of sum cdrs.
  

STL container type definittions

• 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

• virtual ~SumCdrList ()

  Virtual destructor.
  

• virtual List & usageList ()

  Get the list of sum cdrs.
  

• virtual const List & list () const

  Get the list of sum cdrs.
  

• virtual void add (const Cdr &cdr, const Id< BsPage > &pageId)=0

  Add a call details record to sum cdr.
  

• virtual long read (const OSB_DB::Session &session, const Id< BsPage > &pageId)=0

  Read all summary CDR of a balance page.
  

• virtual void remove (const OSB_DB::Session &session, const Id< BsPage > &pageId)=0

  Delete all summary CDR of a balance page in the database.
  

• virtual void save (const OSB_DB::Session &session)

  Store all summary call details records to the database.
  

• void clear ()

  Clear content of the list and clean up memory.
  

Pure wrappers to the STL container.

Remarks:

Do not add an STL opertation to this group if the function does more than just wrapping!

All functions return the STL operation on the list_.

• virtual Iterator begin ()

  Iterator to the beginning of the list.
  

• virtual Iterator end ()

  Iterator to the end of the list.
  

• virtual ConstIterator begin () const

  Const iterator to the beginning of the list.
  

• virtual ConstIterator end () const

  Const iterator to the end of the list.
  

• virtual SizeType size () const

  The size of the list.
  

Protected Attributes

• List list_

  List of sum cdrs.
  

---

Member Typedef Documentation

typedef List::const_iterator OSB_LIB::SumCdrList::ConstIterator

STL const_iterator.

Definition at line 369 of file sumcdr.h.

typedef List::iterator OSB_LIB::SumCdrList::Iterator

STL iterator.

Definition at line 367 of file sumcdr.h.

typedef std::list<SumCdr*> OSB_LIB::SumCdrList::List

Container for a list of sum cdrs.

Definition at line 359 of file sumcdr.h.

typedef List::size_type OSB_LIB::SumCdrList::SizeType

STL container size_type.

Definition at line 371 of file sumcdr.h.

---

Constructor & Destructor Documentation

virtual OSB_LIB::SumCdrList::~SumCdrList

(

)

[inline, virtual]

Virtual destructor.

Definition at line 362 of file sumcdr.h.

References clear().

---

Member Function Documentation

virtual void OSB_LIB::SumCdrList::add	(	const Cdr &	cdr,
		const Id< BsPage > &	pageId
	)			[pure virtual]

Add a call details record to sum cdr.

Parameters:

	cdr	Call details record to be added to the list of sum cdr.
	pageId	Id of the page which the sum cdr belongs to.

Implemented in OSB_LIB::SumCdr01List.

virtual ConstIterator OSB_LIB::SumCdrList::begin

(

)

const [inline, virtual]

Const iterator to the beginning of the list.

Definition at line 388 of file sumcdr.h.

References list_.

virtual Iterator OSB_LIB::SumCdrList::begin

(

)

[inline, virtual]

Iterator to the beginning of the list.

Definition at line 384 of file sumcdr.h.

References list_.

void OSB_LIB::SumCdrList::clear

(

)

Clear content of the list and clean up memory.

Referenced by ~SumCdrList().

virtual ConstIterator OSB_LIB::SumCdrList::end

(

)

const [inline, virtual]

Const iterator to the end of the list.

Definition at line 390 of file sumcdr.h.

References list_.

virtual Iterator OSB_LIB::SumCdrList::end

(

)

[inline, virtual]

Iterator to the end of the list.

Definition at line 386 of file sumcdr.h.

References list_.

virtual const List& OSB_LIB::SumCdrList::list

(

)

const [inline, virtual]

Get the list of sum cdrs.

Definition at line 404 of file sumcdr.h.

References list_.

virtual long OSB_LIB::SumCdrList::read	(	const OSB_DB::Session &	session,
		const Id< BsPage > &	pageId
	)			[pure virtual]

Read all summary CDR of a balance page.

Parameters:

	session	Database session.
	pageId	Balance page id of the sum cdrs.

Returns:

The number of summary cdrs read successfully.

Implemented in OSB_LIB::SumCdr01List.

virtual void OSB_LIB::SumCdrList::remove	(	const OSB_DB::Session &	session,
		const Id< BsPage > &	pageId
	)			[pure virtual]

Delete all summary CDR of a balance page in the database.

Parameters:

	session	Database session.
	pageId	Id of the balance page.

Note:

The function does not delete the summary CDRs in memory. Clients that need this should call clear().

Implemented in OSB_LIB::SumCdr01List.

virtual void OSB_LIB::SumCdrList::save

(

const OSB_DB::Session &

session

)

[virtual]

Store all summary call details records to the database.

Parameters:

session

Database session.

virtual SizeType OSB_LIB::SumCdrList::size

(

)

const [inline, virtual]

The size of the list.

Definition at line 392 of file sumcdr.h.

References list_.

virtual List& OSB_LIB::SumCdrList::usageList

(

)

[inline, virtual]

Get the list of sum cdrs.

This function retrieves a list of pointers that points to the list of SumCdrs.

Definition at line 401 of file sumcdr.h.

References list_.

---

Member Data Documentation

List OSB_LIB::SumCdrList::list_ [protected]

List of sum cdrs.

Definition at line 459 of file sumcdr.h.

Referenced by begin(), end(), list(), size(), and usageList().

---

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

• sumcdr.h

---