OSB_LIB::CpMapperList Class Reference

Collaboration diagram for OSB_LIB::CpMapperList:

[legend]List of all members.

---

Detailed Description

Provide information about classes derived from CpMapper.

Remarks:

Default and copy constructor, assignment and destructor by compiler.

Definition at line 169 of file cpmapper.h.

Public Types

• typedef std::vector< Info > InfoList

  STL containter used to store the type information.
  

• typedef InfoList::const_iterator ConstIterator

  Const iterator to information list.
  

Public Member Functions

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

  Read list from database.
  

• ConstIterator begin () const

  Get const iterator to begin of list.
  

• ConstIterator end () const

  Get const iterator to end of list.
  

• const InfoList & infoList () const

  Read access to the whole list.
  

• const Info * findInfo (CpMapper::Type type) const

  Type info by type id.
  

• const Info * findInfo (const std::string &name) const

  Type info by name.
  

• const Info & getInfo (CpMapper::Type type) const

  Type info by type id.
  

• const Info & getInfo (const std::string &name) const

  Type info by name.
  

Private Member Functions

• Info * find (CpMapper::Type type)

  Find info buffer by type id.
  

• Info * find (const std::string &name)

  Find info buffer by name.
  

Private Attributes

• InfoList infoList_

  Info buffers.
  

Classes

• struct Info

  Store information about a CpMapper class. More...
  

---

Member Typedef Documentation

typedef InfoList::const_iterator OSB_LIB::CpMapperList::ConstIterator

Const iterator to information list.

Definition at line 181 of file cpmapper.h.

typedef std::vector<Info> OSB_LIB::CpMapperList::InfoList

STL containter used to store the type information.

Definition at line 179 of file cpmapper.h.

---

Member Function Documentation

ConstIterator OSB_LIB::CpMapperList::begin

(

)

const [inline]

Get const iterator to begin of list.

Definition at line 196 of file cpmapper.h.

References infoList_.

ConstIterator OSB_LIB::CpMapperList::end

(

)

const [inline]

Get const iterator to end of list.

Definition at line 198 of file cpmapper.h.

References infoList_.

Info* OSB_LIB::CpMapperList::find

(

const std::string &

name

)

[private]

Find info buffer by name.

Info* OSB_LIB::CpMapperList::find

(

CpMapper::Type

type

)

[private]

Find info buffer by type id.

const Info* OSB_LIB::CpMapperList::findInfo

(

const std::string &

name

)

const

Type info by name.

Parameters:

name

Name to search for.

Returns:

Pointer to the information structure about the type. The value is 0 if the name can not be found.

const Info* OSB_LIB::CpMapperList::findInfo

(

CpMapper::Type

type

)

const

Type info by type id.

Parameters:

type

Identifies the type of the mapping class.

Returns:

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

const Info& OSB_LIB::CpMapperList::getInfo

(

const std::string &

name

)

const

Type info by name.

Parameters:

name

Name to search for.

Exceptions:

OsbException

if the name can not be found.

Returns:

Structure with information about the type.

const Info& OSB_LIB::CpMapperList::getInfo

(

CpMapper::Type

type

)

const

Type info by type id.

Parameters:

type

Identifies the type of the mapping class.

Exceptions:

OsbException

in case of an unsupported type.

Returns:

Structure with information about the type.

const InfoList& OSB_LIB::CpMapperList::infoList

(

)

const [inline]

Read access to the whole list.

Definition at line 200 of file cpmapper.h.

References infoList_.

long OSB_LIB::CpMapperList::read

(

const OSB_DB::Session &

session

)

Read list from database.

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

Parameters:

session

Database session to use.

Exceptions:

OsbException

as defined in the gateway class.

Returns:

The number of entries in the list.

---

Member Data Documentation

InfoList OSB_LIB::CpMapperList::infoList_ [private]

Info buffers.

Definition at line 240 of file cpmapper.h.

Referenced by begin(), end(), and infoList().

---

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

• cpmapper.h

---