OSB_LIB::UnitList Class Reference

Collaboration diagram for OSB_LIB::UnitList:

[legend]List of all members.

---

Detailed Description

List of units.

Definition at line 126 of file osbunit.h.

Public Types

• typedef std::map< Unit::Oid,
  Unit > Cont

  STL containers for the units.
  

• typedef Cont::const_iterator ConstIterator

  Const iterator to STL container.
  

Public Member Functions

• size_t size () const

  Get number of units.
  

• ConstIterator begin () const

  Get const iterator to begin of list.
  

• ConstIterator end () const

  Get const iterator to end of list.
  

• size_t read (const OSB_DB::Session &session)

  Read all units from the database.
  

• const Unit & getUnit (const Unit::Oid &oid) const

  Find the name of a unit by its object id.
  

• Unit::Oid getUnit (const std::string &name) const

  Find the object id of a unit by its name.
  

Private Attributes

• Cont cont_

Friends

• class OSB_DB::UnitGw

  Allow the gateway to populate cont_.
  

---

Member Typedef Documentation

typedef Cont::const_iterator OSB_LIB::UnitList::ConstIterator

Const iterator to STL container.

Definition at line 133 of file osbunit.h.

typedef std::map<Unit::Oid, Unit> OSB_LIB::UnitList::Cont

STL containers for the units.

Definition at line 131 of file osbunit.h.

---

Member Function Documentation

ConstIterator OSB_LIB::UnitList::begin

(

)

const

Get const iterator to begin of list.

ConstIterator OSB_LIB::UnitList::end

(

)

const

Get const iterator to end of list.

Unit::Oid OSB_LIB::UnitList::getUnit

(

const std::string &

name

)

const

Find the object id of a unit by its name.

Parameters:

name

Name to search for.

Returns:

The object id of the unit with name, Unit::uiNotSet if no matching unit is found.

const Unit& OSB_LIB::UnitList::getUnit

(

const Unit::Oid &

oid

)

const

Find the name of a unit by its object id.

Parameters:

oid

Object id of the unit to search.

Exceptions:

ObjectNotFound

Returns:

The unit with the matching object id.

size_t OSB_LIB::UnitList::read

(

const OSB_DB::Session &

session

)

Read all units from the database.

Parameters:

session

Database session to use.

Returns:

Number of units in the list.

size_t OSB_LIB::UnitList::size

(

)

const

Get number of units.

---

Friends And Related Function Documentation

friend class OSB_DB::UnitGw [friend]

Allow the gateway to populate cont_.

Definition at line 128 of file osbunit.h.

---

Member Data Documentation

Cont OSB_LIB::UnitList::cont_ [private]

Definition at line 165 of file osbunit.h.

---

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

• osbunit.h

---