OSB_LIB::CpTree Class Reference

Collaboration diagram for OSB_LIB::CpTree:

[legend]List of all members.

---

Detailed Description

Manager of connection points.

The class stores a flat list of connection points and ... ToDo:.

Todo:

List of parent - child relations.

Definition at line 74 of file cptree.h.

Public Types

• typedef std::map< ConnectionPt::Oid,
  ConnectionPt > CpList

  STL container for connection points.
  

• typedef CpList::const_iterator ConstIter

  Const-iterator to connection points.
  

Public Member Functions

• ConstIter begin () const

  Start of connection point list.
  

• ConstIter end () const

  End of connection point list.
  

• const CpList & cpList () const

  Access to the whole list of connection points.
  

• const ConnectionPt * findCp (const ConnectionPt::Oid &cpId) const

  Find a connection point, non-throwing.
  

• const ConnectionPt & getCp (const ConnectionPt::Oid &cpId) const

  Find a connection point, throwing.
  

• bool hasChildren (const ConnectionPt::Oid &cpId) const

  Does the connection point have children?
  

• std::set< ConnectionPt::Oid > getChildren (const ConnectionPt::Oid &cpId) const

  Get list of child connection points.
  

Private Member Functions

• void addCp (const ConnectionPt &cp)

  Add a connection point.
  

• void delCp (const ConnectionPt::Oid &cpId)

  Delete a connetion point.
  

• ConnectionPt * findCp (const ConnectionPt::Oid &cpId)

  Find a connection point.
  

• CpList & cpList ()

  Write access to list of connection points.
  

Private Attributes

• CpList cpList_

  Flat list of connection points.
  

Friends

• class TariffCatalogue

  Provide write access for the tariff catalogue.
  

• class OSB_DB::ConnectionPtGw

  Allow the gateway to clear and populate cpList_.
  

---

Member Typedef Documentation

typedef CpList::const_iterator OSB_LIB::CpTree::ConstIter

Const-iterator to connection points.

Definition at line 83 of file cptree.h.

typedef std::map<ConnectionPt::Oid, ConnectionPt> OSB_LIB::CpTree::CpList

STL container for connection points.

Definition at line 81 of file cptree.h.

---

Member Function Documentation

void OSB_LIB::CpTree::addCp

(

const ConnectionPt &

cp

)

[private]

Add a connection point.

Parameters:

cp

Connection point to add.

Overwrites an existing connection point with the same object id.

ConstIter OSB_LIB::CpTree::begin

(

)

const

Start of connection point list.

CpList& OSB_LIB::CpTree::cpList

(

)

[private]

Write access to list of connection points.

const CpList& OSB_LIB::CpTree::cpList

(

)

const

Access to the whole list of connection points.

void OSB_LIB::CpTree::delCp

(

const ConnectionPt::Oid &

cpId

)

[private]

Delete a connetion point.

Parameters:

cpId

Object id of connection point to delete.

ConstIter OSB_LIB::CpTree::end

(

)

const

End of connection point list.

ConnectionPt* OSB_LIB::CpTree::findCp

(

const ConnectionPt::Oid &

cpId

)

[private]

Find a connection point.

Parameters:

cpId

Object id of the connection point to find.

Returns:

Pointer to the connection point, it is 0 if cpId can not be found.

const ConnectionPt* OSB_LIB::CpTree::findCp

(

const ConnectionPt::Oid &

cpId

)

const

Find a connection point, non-throwing.

Parameters:

cpId

Object id of the connection point to find.

Returns:

Pointer to the connection point, it is 0 if cpId can not be found.

std::set<ConnectionPt::Oid> OSB_LIB::CpTree::getChildren

(

const ConnectionPt::Oid &

cpId

)

const

Get list of child connection points.

const ConnectionPt& OSB_LIB::CpTree::getCp

(

const ConnectionPt::Oid &

cpId

)

const

Find a connection point, throwing.

Parameters:

cpId

Object id of the connection point to find.

Returns:

Reference to the connection point.

Exceptions:

OsbException

if cpId can not be found.

bool OSB_LIB::CpTree::hasChildren

(

const ConnectionPt::Oid &

cpId

)

const

Does the connection point have children?

---

Friends And Related Function Documentation

friend class OSB_DB::ConnectionPtGw [friend]

Allow the gateway to clear and populate cpList_.

Definition at line 78 of file cptree.h.

friend class TariffCatalogue [friend]

Provide write access for the tariff catalogue.

Definition at line 76 of file cptree.h.

---

Member Data Documentation

CpList OSB_LIB::CpTree::cpList_ [private]

Flat list of connection points.

Definition at line 139 of file cptree.h.

---

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

• cptree.h

---