fsCVariableTable Class Reference

#include <fsCVariableTable.h>

Inheritance diagram for fsCVariableTable:

Public Types
enum	{   eLOAD_RESULT_INVALID = 0 , eLOAD_RESULT_SUCCESS_NO_CHECKSUM , eLOAD_RESULT_SUCCESS_WITH_CHECKSUM , eLOAD_RESULT_FAIL_FILESYSTEM_NOT_READY ,   eLOAD_RESULT_FAIL_FILE_NOT_FOUND , eLOAD_RESULT_FAIL_READ_ERROR , eLOAD_RESULT_FAIL_CHECKSUM_INVALID }

Public Member Functions
const fsStr &	fileNameGet () const
std::vector< fsStr >	partKeyCollectionGet (const fsStr &pPartKey) const
std::vector< fsStr >	partValueCollectionGet (const fsStr &pPartVal) const
fsF32	f32Get (const fsStr &pKey) const
fsF32	f32GetWithDefault (const fsStr &pKey, fsF32 pDefault) const
fsS32	s32Get (const fsStr &pKey) const
fsS32	s32GetWithDefault (const fsStr &pKey, fsS32 pDefault) const
fsStr	strGet (const fsStr &pKey) const
fsStr	strGetWithDefault (const fsStr &pKey, const fsStr &pDefault) const
fsBool	boolGet (const fsStr &pKey) const
fsBool	boolGetWithDefault (const fsStr &pKey, fsBool pDefault) const
void	removeKeysContaining (const fsStr &pPartialKey)
fsBool	keyExistsGet (const fsStr &pKey) const
void	merge (fsCVariableTable *pIncoming)
void	s32Set (const fsStr &pKey, fsS32 pVal)
void	f32Set (const fsStr &pKey, fsF32 pVal)
void	strSet (const fsStr &pKey, const fsStr &pVal)
void	boolSet (const fsStr &pKey, fsBool pVal)
fsS32	load (const fsCResourceName &pFileName)
void	save (const fsCResourceName &pFileName) const
fsS32	loadResultGet () const
fsBool	successfullLoadGet () const
	fsCVariableTable ()
virtual	~fsCVariableTable ()

Static Protected Member Functions
static fsStr	downcased (const fsStr &pKey)

Protected Attributes
VarTableMap	mEntries
fsS32	mLoadResult

Static Protected Attributes
static const fsStr	mBoolTrueStr
static const fsStr	mAltBoolTrueStr
static const fsStr	mBoolFalseStr

Friends
class	CVarTableComparer
class	CStringsFile

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
eLOAD_RESULT_INVALID
eLOAD_RESULT_SUCCESS_NO_CHECKSUM
eLOAD_RESULT_SUCCESS_WITH_CHECKSUM
eLOAD_RESULT_FAIL_FILESYSTEM_NOT_READY
eLOAD_RESULT_FAIL_FILE_NOT_FOUND
eLOAD_RESULT_FAIL_READ_ERROR
eLOAD_RESULT_FAIL_CHECKSUM_INVALID

Constructor & Destructor Documentation

fsCVariableTable()

fsCVariableTable::fsCVariableTable

(

)

~fsCVariableTable()

fsCVariableTable::~fsCVariableTable ( )

virtual

Member Function Documentation

boolGet()

fsBool fsCVariableTable::boolGet

(

const fsStr &

pKey

)

const

boolGetWithDefault()

fsBool fsCVariableTable::boolGetWithDefault	(	const fsStr &	pKey,
		fsBool	pDefault ) const

boolSet()

void fsCVariableTable::boolSet	(	const fsStr &	pKey,
		fsBool	pVal )

downcased()

fsStr fsCVariableTable::downcased ( const fsStr & pKey )

staticprotected

f32Get()

fsF32 fsCVariableTable::f32Get

(

const fsStr &

pKey

)

const

f32GetWithDefault()

fsF32 fsCVariableTable::f32GetWithDefault	(	const fsStr &	pKey,
		fsF32	pDefault ) const

f32Set()

void fsCVariableTable::f32Set	(	const fsStr &	pKey,
		fsF32	pVal )

fileNameGet()

const fsStr & fsCVariableTable::fileNameGet ( ) const

inline

keyExistsGet()

fsBool fsCVariableTable::keyExistsGet

(

const fsStr &

pKey

)

const

load()

fsS32 fsCVariableTable::load

(

const fsCResourceName &

pFileName

)

loadResultGet()

fsS32 fsCVariableTable::loadResultGet

(

)

const

merge()

void fsCVariableTable::merge

(

fsCVariableTable *

pIncoming

)

partKeyCollectionGet()

std::vector< fsStr > fsCVariableTable::partKeyCollectionGet

(

const fsStr &

pPartKey

)

const

partValueCollectionGet()

std::vector< fsStr > fsCVariableTable::partValueCollectionGet

(

const fsStr &

pPartVal

)

const

removeKeysContaining()

void fsCVariableTable::removeKeysContaining

(

const fsStr &

pPartialKey

)

s32Get()

fsS32 fsCVariableTable::s32Get

(

const fsStr &

pKey

)

const

s32GetWithDefault()

fsS32 fsCVariableTable::s32GetWithDefault	(	const fsStr &	pKey,
		fsS32	pDefault ) const

s32Set()

void fsCVariableTable::s32Set	(	const fsStr &	pKey,
		fsS32	pVal )

save()

void fsCVariableTable::save

(

const fsCResourceName &

pFileName

)

const

strGet()

fsStr fsCVariableTable::strGet

(

const fsStr &

pKey

)

const

strGetWithDefault()

fsStr fsCVariableTable::strGetWithDefault	(	const fsStr &	pKey,
		const fsStr &	pDefault ) const

strSet()

void fsCVariableTable::strSet	(	const fsStr &	pKey,
		const fsStr &	pVal )

successfullLoadGet()

fsBool fsCVariableTable::successfullLoadGet

(

)

const

Friends And Related Symbol Documentation

CStringsFile

friend class CStringsFile

friend

CVarTableComparer

friend class CVarTableComparer

friend

Member Data Documentation

mAltBoolTrueStr

const fsStr fsCVariableTable::mAltBoolTrueStr

staticprotected

mBoolFalseStr

const fsStr fsCVariableTable::mBoolFalseStr

staticprotected

mBoolTrueStr

const fsStr fsCVariableTable::mBoolTrueStr

staticprotected

mEntries

VarTableMap fsCVariableTable::mEntries

protected

mLoadResult

fsS32 fsCVariableTable::mLoadResult

protected

---

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

• /home/runner/work/fission/fission/libs/fsCore/src/fsCVariableTable.h
• /home/runner/work/fission/fission/libs/fsCore/src/fsCVariableTable.cpp