OSB_LIB::UsageTypeList Class Reference

Collaboration diagram for OSB_LIB::UsageTypeList:

[legend]List of all members.

---

Detailed Description

Provide usage type information from database.

Definition at line 115 of file usagetype.h.

Public Types

• typedef std::vector< Info > Cont

  STL containter used to store the usage type information.
  

• typedef Cont::const_iterator ConstIterator

  Const iterator to internal list.
  

Public Member Functions

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

  Read usage type list from database.
  

• const Cont & infoList () const

  Read access to the whole list.
  

• ConstIterator begin () const

  Iterator to begin of list.
  

• ConstIterator end () const

  Iterator to end of list.
  

• const Info * findInfo (const Cdr::UsageType &type) const

  Get usage type information: non-throwing version.
  

• const Info & getInfo (const Cdr::UsageType &type) const

  Get usage type information.
  

Private Attributes

• Cont infoList_

  Container to store the information.
  

Classes

• struct Info

  Store information about a usage type. More...
  

---

Member Typedef Documentation

typedef Cont::const_iterator OSB_LIB::UsageTypeList::ConstIterator

Const iterator to internal list.

Definition at line 132 of file usagetype.h.

typedef std::vector<Info> OSB_LIB::UsageTypeList::Cont

STL containter used to store the usage type information.

Definition at line 130 of file usagetype.h.

---

Member Function Documentation

ConstIterator OSB_LIB::UsageTypeList::begin

(

)

const

Iterator to begin of list.

ConstIterator OSB_LIB::UsageTypeList::end

(

)

const

Iterator to end of list.

const Info* OSB_LIB::UsageTypeList::findInfo

(

const Cdr::UsageType &

type

)

const

Get usage type information: non-throwing version.

Parameters:

type

Usage type to search.

Returns:

Pointer to the information structure about the type. The value is 0 in case of an unsupported or unknown usage type.

const Info& OSB_LIB::UsageTypeList::getInfo

(

const Cdr::UsageType &

type

)

const

Get usage type information.

Parameters:

type

Usage type to search.

Exceptions:

OsbException

in case of an unsupported usage type.

Returns:

Structure with information about the usage type type.

const Cont& OSB_LIB::UsageTypeList::infoList

(

)

const

Read access to the whole list.

void OSB_LIB::UsageTypeList::read

(

const OSB_DB::Session &

session

)

Read usage type list from database.

Parameters:

session

Database session to use.

Wraps to OSB_DB::UsageTypeGw::fetch().

---

Member Data Documentation

Cont OSB_LIB::UsageTypeList::infoList_ [private]

Container to store the information.

Definition at line 170 of file usagetype.h.

---

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

• usagetype.h

---