OSB_LIB::Modules Class Reference

Collaboration diagram for OSB_LIB::Modules:

[legend]List of all members.

---

Detailed Description

List of OSB modules.

Definition at line 166 of file modules.h.

Public Types

• typedef std::list< Module > Cont

  STL container to store modules.
  

• typedef Cont::const_iterator ConstIter

  Const iterator to modules list.
  

Public Member Functions

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

  Read all modules from the database.
  

• const Module & get (ModuleId id) const

  Get a specific OSB module.
  

• ConstIter begin () const

  Get iterator to begin of module list.
  

• ConstIter end () const

  Get iterator to end of module list.
  

• bool empty () const

  List of modules empty?
  

• const Cont & cont () const

  Read access to all modules.
  

Private Member Functions

• Module & get (ModuleId id)

  Get a specific OSB module.
  

Private Attributes

• Cont cont_

  List of modules.
  

Friends

• class UserMgmtCfg

  Allow non-const access to a module.
  

---

Member Typedef Documentation

typedef Cont::const_iterator OSB_LIB::Modules::ConstIter

Const iterator to modules list.

Definition at line 174 of file modules.h.

typedef std::list<Module> OSB_LIB::Modules::Cont

STL container to store modules.

Definition at line 172 of file modules.h.

---

Member Function Documentation

ConstIter OSB_LIB::Modules::begin

(

)

const

Get iterator to begin of module list.

const Cont& OSB_LIB::Modules::cont

(

)

const

Read access to all modules.

The list is sorted by module name.

Unless read() has been previously called the list will be empty.

bool OSB_LIB::Modules::empty

(

)

const

List of modules empty?

ConstIter OSB_LIB::Modules::end

(

)

const

Get iterator to end of module list.

Module& OSB_LIB::Modules::get

(

ModuleId

id

)

[private]

Get a specific OSB module.

Parameters:

id

The id of the module to retrieve.

Exceptions:

ObjectNotFound

if the module does not exist.

Returns:

The module for id.

const Module& OSB_LIB::Modules::get

(

ModuleId

id

)

const

Get a specific OSB module.

Parameters:

id

The id of the module to retrieve.

Exceptions:

ObjectNotFound

if the module does not exist.

Returns:

The module for id.

void OSB_LIB::Modules::read

(

const OSB_DB::Session &

session

)

Read all modules from the database.

Parameters:

session

Database session to use.

Read all modules from the database and sorts the list by module name.

---

Friends And Related Function Documentation

friend class UserMgmtCfg [friend]

Allow non-const access to a module.

Definition at line 168 of file modules.h.

---

Member Data Documentation

Cont OSB_LIB::Modules::cont_ [private]

List of modules.

Definition at line 226 of file modules.h.

---

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

• modules.h

---