OpenJAUS SAE SDK  6.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
openjaus::system::IniConfiguration Class Reference

#include <IniConfiguration.h>

Public Member Functions

 IniConfiguration ()
 
virtual ~IniConfiguration ()
 
std::string getFileName () const
 
bool setFileName (std::string fileName)
 
bool load (std::string fileName)
 
const std::map< std::string, Setting * > & getSettingMap () const
 
virtual std::string toString () const
 
template<class Type >
void set (const std::string &key, Type value)
 
template<class Type >
Type get (const std::string &key) const
 
template<class Type >
Type get (const std::string &key, Type defaultValue) const
 
template<class Type >
bool tryGet (const std::string &key, Type &value) const
 
bool comment (const std::string &key, std::string comment)
 
bool fileExists ()
 

Protected Member Functions

bool parseSettings (std::istream &istream, std::map< std::string, Setting *> &settingMap)
 
void settingToStream (std::ostream &ostream, Setting *setting) const
 

Protected Attributes

std::string fileName
 
std::map< std::string, Setting * > settingMap
 
std::map< std::string, Setting * > originalSettings
 
bool isDirty
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const IniConfiguration &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const IniConfiguration *object)
 

Constructor & Destructor Documentation

◆ IniConfiguration()

openjaus::system::IniConfiguration::IniConfiguration ( )

◆ ~IniConfiguration()

openjaus::system::IniConfiguration::~IniConfiguration ( )
virtual

Member Function Documentation

◆ comment()

bool openjaus::system::IniConfiguration::comment ( const std::string &  key,
std::string  comment 
)
inline

◆ fileExists()

bool openjaus::system::IniConfiguration::fileExists ( )

◆ get() [1/2]

template<class Type >
Type openjaus::system::IniConfiguration::get ( const std::string &  key) const
inline

◆ get() [2/2]

template<class Type >
Type openjaus::system::IniConfiguration::get ( const std::string &  key,
Type  defaultValue 
) const
inline

◆ getFileName()

std::string openjaus::system::IniConfiguration::getFileName ( ) const

◆ getSettingMap()

const std::map< std::string, Setting * > & openjaus::system::IniConfiguration::getSettingMap ( ) const

◆ load()

bool openjaus::system::IniConfiguration::load ( std::string  fileName)

◆ parseSettings()

bool openjaus::system::IniConfiguration::parseSettings ( std::istream &  istream,
std::map< std::string, Setting *> &  settingMap 
)
protected

◆ set()

template<class Type >
void openjaus::system::IniConfiguration::set ( const std::string &  key,
Type  value 
)
inline

◆ setFileName()

bool openjaus::system::IniConfiguration::setFileName ( std::string  fileName)

◆ settingToStream()

void openjaus::system::IniConfiguration::settingToStream ( std::ostream &  ostream,
Setting setting 
) const
protected

◆ toString()

std::string openjaus::system::IniConfiguration::toString ( ) const
virtual

◆ tryGet()

template<class Type >
bool openjaus::system::IniConfiguration::tryGet ( const std::string &  key,
Type &  value 
) const
inline

Friends And Related Function Documentation

◆ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const IniConfiguration object 
)
friend

◆ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const IniConfiguration object 
)
friend

Member Data Documentation

◆ fileName

std::string openjaus::system::IniConfiguration::fileName
protected

◆ isDirty

bool openjaus::system::IniConfiguration::isDirty
mutableprotected

◆ originalSettings

std::map<std::string, Setting*> openjaus::system::IniConfiguration::originalSettings
protected

◆ settingMap

std::map<std::string, Setting*> openjaus::system::IniConfiguration::settingMap
mutableprotected

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