GrayLib::cTemplateList Class Reference

#include <cTemplateList.h>

Public Member Functions
	cTemplateList ()
ITERATE_t	get_EnumQty () const
float	get_ProbabilityTotal () const
void	SetClear ()
cTemplateEntry &	GetValAt (ITERATE_t index)
const cTemplateEntry &	GetValAtC (ITERATE_t index) const
const cTemplateEntry *	GetValAtProbability (float fProbability) const
const cTemplateEntry *	GetValAtScale (float fRandValScale) const
const cTemplateEntry *	GetValRandom (cRandomFloat *pRand=nullptr) const
cStringA	GetValString (void)
bool	AddValAt (ITERATE_t iIndex, float fProbability, const cVariant &vVal)
bool	AddVal (float fProbability, const cVariant &vVal)
bool	AddVal (const cVariant &vVal)
HRESULT	SetEntryDef (ITERATE_t iEntry, const cVariant &vVal)
HRESULT	SetEntryQty (ITERATE_t iEntry, ITERATE_t iQty)
HRESULT	SetEntryChance (ITERATE_t iEntry, float fChance)
HRESULT	s_LoadPropsTemplate (cIniSectionData *pSection)
HRESULT	LoadTemplateFile (const FILECHAR_t *pszFileName)
	UNITTEST_FRIEND (cTemplateList)

Detailed Description

Probability distribution of values.

Constructor & Destructor Documentation

cTemplateList()

GrayLib::cTemplateList::cTemplateList ( )

inline

Member Function Documentation

AddVal() [1/2]

bool GrayLib::cTemplateList::AddVal

(

const cVariant &

vVal

)

Add a new item defining the template.

AddVal() [2/2]

bool GrayLib::cTemplateList::AddVal	(	float	fProbability,
		const cVariant &	vVal
	)

vVal.IsEmpty() is OK !

AddValAt()

bool GrayLib::cTemplateList::AddValAt	(	ITERATE_t	iIndex,
		float	fProbability,
		const cVariant &	vVal
	)

vVal.IsEmpty() is OK !

get_EnumQty()

ITERATE_t GrayLib::cTemplateList::get_EnumQty ( ) const

inline

get_ProbabilityTotal()

float GrayLib::cTemplateList::get_ProbabilityTotal ( ) const

inline

GetValAt()

cTemplateEntry& GrayLib::cTemplateList::GetValAt ( ITERATE_t  index )

inline

GetValAtC()

const cTemplateEntry& GrayLib::cTemplateList::GetValAtC ( ITERATE_t  index ) const

inline

GetValAtProbability()

const cTemplateEntry * GrayLib::cTemplateList::GetValAtProbability

(

float

fProbability

)

const

Traverse all the values up to this Probability. What if there are none ?!

GetValAtScale()

const cTemplateEntry * GrayLib::cTemplateList::GetValAtScale

(

float

fRandValScale

)

const

fRandVal = 0 to 1

GetValRandom()

const cTemplateEntry * GrayLib::cTemplateList::GetValRandom

(

cRandomFloat *

pRand = nullptr

)

const

• pRand = my private random number seed.

GetValString()

cStringA GrayLib::cTemplateList::GetValString

(

void

)

Get one string to represent the entire template list. May get WAY too long!

LoadTemplateFile()

HRESULT GrayLib::cTemplateList::LoadTemplateFile

(

const FILECHAR_t *

pszFileName

)

Load the template from a file.

s_LoadPropsTemplate()

HRESULT GrayLib::cTemplateList::s_LoadPropsTemplate

(

cIniSectionData *

pSection

)

Take the whole line

SetClear()

void GrayLib::cTemplateList::SetClear ( )

inline

SetEntryChance()

HRESULT GrayLib::cTemplateList::SetEntryChance	(	ITERATE_t	iEntry,
		float	fChance
	)

SetEntryDef()

HRESULT GrayLib::cTemplateList::SetEntryDef	(	ITERATE_t	iEntry,
		const cVariant &	vVal
	)

SetEntryQty()

HRESULT GrayLib::cTemplateList::SetEntryQty	(	ITERATE_t	iEntry,
		ITERATE_t	iQty
	)

UNITTEST_FRIEND()

GrayLib::cTemplateList::UNITTEST_FRIEND

(

cTemplateList

)

---

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

• c:/Dennis/Source/Gray/GrayLib/include/Misc/cTemplateList.h
• c:/Dennis/Source/Gray/GrayLib/src/Misc/cTemplateList.cpp