Dokumentacja klasy common::Config
[Moduł Config]

Konfiguracja. Więcej...

#include <Config.hpp>

Diagram dziedziczenia dla common::Config

common::Item

Lista wszystkich składowych.

Metody publiczne

 Config ()
 ~Config ()
void LoadFromString (const tstring &S)
 Wczytuje konfigurację, w razie błędu rzuca wyjątek.
void LoadFromStream (Stream *S)
 Wczytuje konfigurację, w razie błędu rzuca wyjątek.
void LoadFromFile (const tstring &FileName)
 Wczytuje konfigurację, w razie błędu rzuca wyjątek.
void SaveToString (tstring *S) const
 Zapisuje konfigurację, w razie błędu rzuca wyjątek.
void SaveToStream (Stream *S) const
 Zapisuje konfigurację, w razie błędu rzuca wyjątek.
void SaveToFile (const tstring &FileName) const
 Zapisuje konfigurację, w razie błędu rzuca wyjątek.
Item * GetItem (const tstring &Path)
 Zwraca element o podanej ścieżce lub NULL, jeśli nie znaleziono.
Item * MustGetItem (const tstring &Path)
 Zwraca element o podanej ścieżce. Jeśli nie znaleziono, rzuca wyjątek.
bool GetData (const tstring &Path, tstring *Data)
 Zwraca dane elementu o podanej ścieżce.
void MustGetData (const tstring &Path, tstring *Data)
 Zwraca dane elementu o podanej ścieżce.
bool ItemExists (const tstring &Path)
 Zwraca true, jesli istnieje element o podanej ścieżce - niezależnie jakiego jest typu.
void ItemMustExists (const tstring &Path)
 Jeśli element o podanej ścieżce nie istnieje, rzuca wyjątek.
bool SetItem (const tstring &Path, Item *a_Item, uint4 CreateMode)
 Ustawia element do podanej ściezki. Jeśli się nie uda, zwraca false.
void MustSetItem (const tstring &Path, Item *a_Item, uint4 CreateMode)
 Ustawia element do podanej ściezki. Jeśli się nie uda, rzuca wyjątek.
bool SetData (const tstring &Path, const tstring &Data, uint4 CreateMode)
 Ustawia dane elementu tekstowego o podanej ścieżce. Jeśli sie nie uda, zwraca false.
void MustSetData (const tstring &Path, const tstring &Data, uint4 CreateMode)
 Ustawia dane elementu tekstowego o podanej ścieżce. Jeśli się nie uda, rzuca wyjątek.
bool DeleteItem (const tstring &Path)
 Usuwa element o podanej ścieżce.
void MustDeleteItem (const tstring &Path)
void GetElementNames (STRING_VECTOR *OutNames)
 Zwraca listę nazw elementów.
template<typename T>
T * GetItemEx (const tstring &Path)
 Zwraca element podanego typu spod podanej ściezki.
template<typename T>
T * MustGetItemEx (const tstring &Path)
 Zwraca element podanego typu spod podanej ściezki.
template<typename T>
bool GetDataEx (const tstring &Path, T *Data)
 Zwraca dane spod podanej ścieżki skonwertowane do podanego typu.
template<typename T>
void MustGetDataEx (const tstring &Path, T *Data)
 Zwraca dane spod podanej ścieżki skonwertowane do podanego typu.
template<typename T>
bool ItemExistsEx (const tstring &Path)
 Jeśli element o podanej ścieżce nie istnieje lub nie jest takiego typu jak podany, zwraca false.
template<typename T>
void ItemMustExistsEx (const tstring &Path)
 Jeśli element o podanej ścieżce nie istnieje lub nie jest takiego typu jak podany, rzuca wyjątek.
template<typename T>
bool SetDataEx (const tstring &Path, const T &Data, uint4 CreateMode)
 Ustawia dane elementu tekstowego o podanej ścieżce na łańcuch skonwertowany z podanej wartości danego typu.
template<typename T>
void MustSetDataEx (const tstring &Path, const T &Data, uint4 CreateMode)
 Ustawia dane elementu tekstowego o podanej ścieżce na łańcuch skonwertowany z podanej wartości danego typu.

Statyczne atrybuty publiczne

Flagi bitowe


static const uint4 CM_MUST_EXIST = 0x02
 Zapisywane dane czy element musi wcześniej istnieć. Zostaje zastąpiony.
static const uint4 CM_MUST_NOT_EXIST = 0x04
 Zapisywane dane czy element nie może wcześniej istnieć. Zostaje utworzony.
static const uint4 CM_CREATE_PATH = 0x08
 W razie nieistnienia, tworzona jest cała hierarchia konfiguracji aż do zapisywanego elementu.
static const uint4 CM_SAME_TYPE = 0x10
 Zapisywany element, jeśli już istnieje, musi być tego samego typu co nowy.

Przyjaciele

class Config_pimpl

Opis szczegółowy

Konfiguracja.

Tej klasy należy używać zarówno jako główną konfigurację jak i używana jest do przechowywania podkonfiguracji. Zawiera mapę: Klucz [tstring] => Element [Item]

Dokumentacja konstruktora i destruktora

common::Config::Config (  ) 

common::Config::~Config (  ) 

Dokumentacja funkcji składowych

void common::Config::LoadFromString ( const tstring &  S  ) 

Wczytuje konfigurację, w razie błędu rzuca wyjątek.

void common::Config::LoadFromStream ( Stream *  S  ) 

Wczytuje konfigurację, w razie błędu rzuca wyjątek.

void common::Config::LoadFromFile ( const tstring &  FileName  ) 

Wczytuje konfigurację, w razie błędu rzuca wyjątek.

void common::Config::SaveToString ( tstring *  S  )  const

Zapisuje konfigurację, w razie błędu rzuca wyjątek.

void common::Config::SaveToStream ( Stream *  S  )  const

Zapisuje konfigurację, w razie błędu rzuca wyjątek.

void common::Config::SaveToFile ( const tstring &  FileName  )  const

Zapisuje konfigurację, w razie błędu rzuca wyjątek.

Item* common::Config::GetItem ( const tstring &  Path  ) 

Zwraca element o podanej ścieżce lub NULL, jeśli nie znaleziono.

Item* common::Config::MustGetItem ( const tstring &  Path  ) 

Zwraca element o podanej ścieżce. Jeśli nie znaleziono, rzuca wyjątek.

bool common::Config::GetData ( const tstring &  Path,
tstring *  Data 
)

Zwraca dane elementu o podanej ścieżce.

Jesli nie znaleziono lub to nie jest element z danymi, zwraca false, a Data jest niezdefiniowane.

void common::Config::MustGetData ( const tstring &  Path,
tstring *  Data 
)

Zwraca dane elementu o podanej ścieżce.

Jesli nie znaleziono lub to nie jest element z danymi, rzuca wyjątek.

bool common::Config::ItemExists ( const tstring &  Path  ) 

Zwraca true, jesli istnieje element o podanej ścieżce - niezależnie jakiego jest typu.

void common::Config::ItemMustExists ( const tstring &  Path  ) 

Jeśli element o podanej ścieżce nie istnieje, rzuca wyjątek.

bool common::Config::SetItem ( const tstring &  Path,
Item *  a_Item,
uint4  CreateMode 
)

Ustawia element do podanej ściezki. Jeśli się nie uda, zwraca false.

void common::Config::MustSetItem ( const tstring &  Path,
Item *  a_Item,
uint4  CreateMode 
)

Ustawia element do podanej ściezki. Jeśli się nie uda, rzuca wyjątek.

bool common::Config::SetData ( const tstring &  Path,
const tstring &  Data,
uint4  CreateMode 
)

Ustawia dane elementu tekstowego o podanej ścieżce. Jeśli sie nie uda, zwraca false.

void common::Config::MustSetData ( const tstring &  Path,
const tstring &  Data,
uint4  CreateMode 
)

Ustawia dane elementu tekstowego o podanej ścieżce. Jeśli się nie uda, rzuca wyjątek.

bool common::Config::DeleteItem ( const tstring &  Path  ) 

Usuwa element o podanej ścieżce.

void common::Config::MustDeleteItem ( const tstring &  Path  ) 

void common::Config::GetElementNames ( STRING_VECTOR *  OutNames  ) 

Zwraca listę nazw elementów.

Dokumentacja przyjaciół i funkcji związanych

friend class Config_pimpl [friend]

Dokumentacja atrybutów składowych

const uint4 common::Config::CM_MUST_EXIST = 0x02 [static]

Zapisywane dane czy element musi wcześniej istnieć. Zostaje zastąpiony.

const uint4 common::Config::CM_MUST_NOT_EXIST = 0x04 [static]

Zapisywane dane czy element nie może wcześniej istnieć. Zostaje utworzony.

const uint4 common::Config::CM_CREATE_PATH = 0x08 [static]

W razie nieistnienia, tworzona jest cała hierarchia konfiguracji aż do zapisywanego elementu.

const uint4 common::Config::CM_SAME_TYPE = 0x10 [static]

Zapisywany element, jeśli już istnieje, musi być tego samego typu co nowy.

Dokumentacja dla tej klasy została wygenerowana z pliku:
Wygenerowano Sat Mar 29 18:17:01 2008 dla CommonLib programem  doxygen 1.5.5