ADTF
inifile.h
Go to the documentation of this file.
1 
7 #ifndef _INIFILE_CLASS_HEADER_
8 #define _INIFILE_CLASS_HEADER_
9 
10 namespace A_UTILS_NS
11 {
12 
18 class DOEXPORT cIniFile
19 {
20  A_UTILS_D(cIniFile)
21 
22  protected:
23  cString m_strSection;
24  mutable cDOM m_oDoc;
25 
26  public:
30  cIniFile();
31 
35  virtual ~cIniFile();
36 
46  tResult Load(const cFilename& strFilename = "", const tBool& bParse = tTrue);
47 
53  tResult Save(const cFilename& strFilename = "");
54 
60  tResult RemoveSection(const cString& strSection);
61 
68  tResult RemoveKey(const cString& strSection, const cString& strName);
69 
77  tBool Set (const cString& strSection, const cString& strName, const cString& strValue="");
85  tBool SetBool (const cString& strSection, const cString& strName, const tBool &bValue);
93  tBool SetInt (const cString& strSection, const cString& strName, const int &iValue);
94 
102  tBool SetFloat64 (const cString& strSection, const cString& strName, const tFloat64 &f64Value);
103 
111  cString Get (const cString& strSection, const cString& strName, const cString& strDefault="") const;
112 
120  tBool GetBool (const cString& strSection, const cString& strName, const tBool &bDefault=false) const;
121 
128  tBool Exists (const cString& strSection, const cString& strName) const;
129 
137  int GetInt (const cString& strSection, const cString& strName, const int &iDefault=0) const;
145  tFloat64 GetFloat64 (const cString& strSection, const cString& strName, const tFloat64 &f64Default=0) const;
146 
152  tVoid SetSectionName(const cString& strSection);
157  cString GetSectionName() const;
158 
165  cString SectionGet (const cString& strName, const cString& strDefault="") const;
166 
173  tBool SectionGetBool (const cString& strName, const tBool &bDefault=false) const;
180  int SectionGetInt (const cString& strName, const int &iDefault=0) const;
187  tFloat64 SectionGetFloat64 (const cString& strName, const tFloat64 &f64Default=0) const;
188 
189  protected:
194  cFilename LookupFile() const;
195 
196 };
197 
198 } // namespace A_UTILS_NS
199 
200 #endif // _INIFILE_CLASS_HEADER_
tVoid
void tVoid
The tVoid is always the definition for the void (non-type).
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/base/types.h:44
tFloat64
double tFloat64
type definition for Float64 (64bit double values) (platform and compiler independent type).
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/base/types.h:66
tBool
bool tBool
The tBool defines the type for the Values tTrue and tFalse (platform and compiler dependent).
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/base/types.h:49
A_UTILS_NS::cDOM
cDOM implements a XML parser which can be used to read in XML files and perform simple (!...
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/std/dom.h:459
A_UTILS_NS::cFilename
File name class.
Definition: filename.h:59
A_UTILS_NS::cIniFile
INI file handling.
Definition: inifile.h:19
A_UTILS_NS::cIniFile::m_strSection
cString m_strSection
Internally used name of section.
Definition: inifile.h:23
A_UTILS_NS::cIniFile::GetInt
int GetInt(const cString &strSection, const cString &strName, const int &iDefault=0) const
Returns an integer value.
A_UTILS_NS::cIniFile::SetFloat64
tBool SetFloat64(const cString &strSection, const cString &strName, const tFloat64 &f64Value)
Sets a float value.
A_UTILS_NS::cIniFile::SetInt
tBool SetInt(const cString &strSection, const cString &strName, const int &iValue)
Sets an integer value.
A_UTILS_NS::cIniFile::RemoveKey
tResult RemoveKey(const cString &strSection, const cString &strName)
Removes a key from a section.
A_UTILS_NS::cIniFile::m_oDoc
cDOM m_oDoc
Internally used DOM object.
Definition: inifile.h:24
A_UTILS_NS::cIniFile::GetFloat64
tFloat64 GetFloat64(const cString &strSection, const cString &strName, const tFloat64 &f64Default=0) const
Returns a float value.
A_UTILS_NS::cIniFile::GetSectionName
cString GetSectionName() const
Returns the current section name.
A_UTILS_NS::cIniFile::~cIniFile
virtual ~cIniFile()
Destructor.
A_UTILS_NS::cIniFile::Load
tResult Load(const cFilename &strFilename="", const tBool &bParse=tTrue)
Loads an INI file.
A_UTILS_NS::cIniFile::GetBool
tBool GetBool(const cString &strSection, const cString &strName, const tBool &bDefault=false) const
Returns a bool value.
A_UTILS_NS::cIniFile::SectionGetInt
int SectionGetInt(const cString &strName, const int &iDefault=0) const
Returns an integer value.
A_UTILS_NS::cIniFile::cIniFile
cIniFile()
Default constructor.
A_UTILS_NS::cIniFile::Save
tResult Save(const cFilename &strFilename="")
Saves an INI file.
A_UTILS_NS::cIniFile::SetBool
tBool SetBool(const cString &strSection, const cString &strName, const tBool &bValue)
Sets a bool value.
A_UTILS_NS::cIniFile::Get
cString Get(const cString &strSection, const cString &strName, const cString &strDefault="") const
Returns a string value.
A_UTILS_NS::cIniFile::SectionGetBool
tBool SectionGetBool(const cString &strName, const tBool &bDefault=false) const
Returns a bool value.
A_UTILS_NS::cIniFile::SetSectionName
tVoid SetSectionName(const cString &strSection)
Sets the current section for the Section* methods.
A_UTILS_NS::cIniFile::RemoveSection
tResult RemoveSection(const cString &strSection)
Removes an entire section.
A_UTILS_NS::cIniFile::LookupFile
cFilename LookupFile() const
Returns the default filename.
A_UTILS_NS::cIniFile::Set
tBool Set(const cString &strSection, const cString &strName, const cString &strValue="")
Sets a string value.
A_UTILS_NS::cIniFile::SectionGet
cString SectionGet(const cString &strName, const cString &strDefault="") const
Returns a string value.
A_UTILS_NS::cIniFile::Exists
tBool Exists(const cString &strSection, const cString &strName) const
Checks if an entry exists in the ini file.
A_UTILS_NS::cIniFile::SectionGetFloat64
tFloat64 SectionGetFloat64(const cString &strName, const tFloat64 &f64Default=0) const
Returns a float value.
A_UTILS_NS::cResult
A common result class usable as return value throughout.
Definition: builds/digitalwerk/solutions/adtf_content/adtf_base/adtf_core/src/libraries/a_utils/include/a_utils/core/result.h:18
A_UTILS_NS::string_base< cStackString >
tTrue
#define tTrue
Value for tBool.
Definition: constants.h:62
A_UTILS_D
#define A_UTILS_D(__pclassname_)
Helper macro for d-pattern definitions.
Definition: d_ptr.h:270
A_UTILS_NS
ADTF A_UTIL Namespace - Within adtf this is used as adtf::util or adtf_util.
Definition: d_ptr.h:11