OSB_LIB::AddressTypeList Class Reference

Collaboration diagram for OSB_LIB::AddressTypeList:

[legend]List of all members.

---

Detailed Description

Provide information about address type.

Remarks:

Default and copy constructor, assignment and destructor by compiler.

Definition at line 261 of file address.h.

Public Types

STL container type definitions

• typedef std::map< AddressType,
  AddressTypeInfo > List

  STL containter used to store the type information.
  

• typedef List::iterator Iterator

  STL iterator.
  

• typedef List::const_iterator ConstIterator

  STL const_iterator.
  

• typedef List::size_type SizeType

  STL container size_type.
  

• typedef List::key_type KeyType

  STL container key_type.
  

Public Member Functions

• const List & list () const

  Read access to the whole list.
  

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

  Read list from database.
  

• const AddressTypeInfo * findAddressType (AddressType typeId) const

  Find AddressType by type id.
  

• const AddressTypeInfo & getAddressType (AddressType typeId) const

  Get AddressType by type id. Similar to the find AddressType function, except that it throws if the type is not found.
  

Pure wrappers to the STL container

Remarks:

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

All functions return the STL operation on list_.

• Iterator begin ()

  Iterator to the beginning of the list.
  

• Iterator end ()

  Iterator to the end of the list.
  

• Iterator find (const KeyType &k)

  Finds an element whose key is k.
  

• ConstIterator begin () const

  Const iterator to the beginning of the list.
  

• ConstIterator end () const

  Const iterator to the end of the list.
  

• ConstIterator find (const KeyType &k) const

  Finds an element whose key is k.
  

• SizeType size () const

  The size of the list.
  

Private Attributes

• List list_

  Container for address types.
  

---

Member Typedef Documentation

typedef List::const_iterator OSB_LIB::AddressTypeList::ConstIterator

STL const_iterator.

Definition at line 270 of file address.h.

typedef List::iterator OSB_LIB::AddressTypeList::Iterator

STL iterator.

Definition at line 268 of file address.h.

typedef List::key_type OSB_LIB::AddressTypeList::KeyType

STL container key_type.

Definition at line 274 of file address.h.

typedef std::map<AddressType, AddressTypeInfo> OSB_LIB::AddressTypeList::List

STL containter used to store the type information.

Definition at line 266 of file address.h.

typedef List::size_type OSB_LIB::AddressTypeList::SizeType

STL container size_type.

Definition at line 272 of file address.h.

---

Member Function Documentation

ConstIterator OSB_LIB::AddressTypeList::begin

(

)

const [inline]

Const iterator to the beginning of the list.

Definition at line 295 of file address.h.

References list_.

Iterator OSB_LIB::AddressTypeList::begin

(

)

[inline]

Iterator to the beginning of the list.

Definition at line 289 of file address.h.

References list_.

ConstIterator OSB_LIB::AddressTypeList::end

(

)

const [inline]

Const iterator to the end of the list.

Definition at line 297 of file address.h.

References list_.

Iterator OSB_LIB::AddressTypeList::end

(

)

[inline]

Iterator to the end of the list.

Definition at line 291 of file address.h.

References list_.

ConstIterator OSB_LIB::AddressTypeList::find

(

const KeyType &

k

)

const [inline]

Finds an element whose key is k.

Definition at line 299 of file address.h.

References list_.

Iterator OSB_LIB::AddressTypeList::find

(

const KeyType &

k

)

[inline]

Finds an element whose key is k.

Definition at line 293 of file address.h.

References list_.

const AddressTypeInfo* OSB_LIB::AddressTypeList::findAddressType

(

AddressType

typeId

)

const

Find AddressType by type id.

Parameters:

typeId

Identifies the type of address.

Returns:

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

const AddressTypeInfo& OSB_LIB::AddressTypeList::getAddressType

(

AddressType

typeId

)

const

Get AddressType by type id. Similar to the find AddressType function, except that it throws if the type is not found.

Parameters:

typeId

Identifies the type of address.

Returns:

Reference to the information structure about the type.

Exceptions:

OsbException

205 in case of an unsupported or unknown type.

const List& OSB_LIB::AddressTypeList::list

(

)

const [inline]

Read access to the whole list.

Definition at line 278 of file address.h.

References list_.

long OSB_LIB::AddressTypeList::read

(

const OSB_DB::Session &

session

)

Read list from database.

The function calls OSB_DB::AddressGw::fetch to populate its type list with the entries in the database.

Parameters:

session

Database session to use.

Returns:

The number of entries in the list.

Exceptions:

OsbException

as specified by the gateway class.

SizeType OSB_LIB::AddressTypeList::size

(

)

const [inline]

The size of the list.

Definition at line 302 of file address.h.

References list_.

---

Member Data Documentation

List OSB_LIB::AddressTypeList::list_ [private]

Container for address types.

Definition at line 346 of file address.h.

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

---

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

• address.h

---