AutotestRegister Interface Reference

This class should be created once per autotest / autotest-entity. More...

Public Member Functions
void	Init (string pageName)
	Initializes register with pageName which is then used for all child result files as page name.
string	GetAutotestPageName ()
	Returns page name for this autotest.
string	GetWorldFileFolderPath ()
	Returns path to world file of this autotest.
int	GetTestIndex ()
	Returns index of this autotest (if we have multiple entities, or world files in single autotest we can track.
bool	DoesMeasurementExist (string name)
	Checks if file with given measurement name exists.
MeasurementFile	OpenMeasurementFile (string name, string measurementTitle, MeasurementType type, bool overwriteExisting=true)
	This opens new measurement file for adding data to it. By default it will delete old results if there are any.
void	UploadLogFileWithResults ()
	If this is called it will automatically prepare "measurement file" which will upload console.log into.
void	SavePersistentData (string name, string data)
	This allows you to save your own data which you can later read even in next test run (after exe finished)
string	LoadPersistentData (string name)
	Returns previously stored data (by calling SavePersistentData) under given name (works even between exe runs)
int	GetNumberOfDataLines (string measurementName)
	Returns number of lines givenmeasurement file has inside.
int	GetNumberOfWorldFiles ()
	Returns number of .ent files in current autotest folder.

Protected Attributes
string	m_worldFileFolder
string	m_autotestPageName
int	m_testIndex = 0
	This number serves to keep track of index of test we are running (usefull when we have multiple world files in single autotest)

Detailed Description

This class should be created once per autotest / autotest-entity.

Member Function Documentation

DoesMeasurementExist()

bool AutotestRegister.DoesMeasurementExist

(

string

name

)

Checks if file with given measurement name exists.

GetAutotestPageName()

string AutotestRegister.GetAutotestPageName

(

)

Returns page name for this autotest.

GetNumberOfDataLines()

int AutotestRegister.GetNumberOfDataLines

(

string

measurementName

)

Returns number of lines givenmeasurement file has inside.

GetNumberOfWorldFiles()

int AutotestRegister.GetNumberOfWorldFiles

(

)

Returns number of .ent files in current autotest folder.

GetTestIndex()

int AutotestRegister.GetTestIndex

(

)

Returns index of this autotest (if we have multiple entities, or world files in single autotest we can track.

GetWorldFileFolderPath()

string AutotestRegister.GetWorldFileFolderPath

(

)

Returns path to world file of this autotest.

Init()

void AutotestRegister.Init

(

string

pageName

)

Initializes register with pageName which is then used for all child result files as page name.

LoadPersistentData()

string AutotestRegister.LoadPersistentData

(

string

name

)

Returns previously stored data (by calling SavePersistentData) under given name (works even between exe runs)

OpenMeasurementFile()

MeasurementFile AutotestRegister.OpenMeasurementFile	(	string	name,
		string	measurementTitle,
		MeasurementType	type,
		bool	overwriteExisting = true
	)

This opens new measurement file for adding data to it. By default it will delete old results if there are any.

SavePersistentData()

void AutotestRegister.SavePersistentData	(	string	name,
		string	data
	)

This allows you to save your own data which you can later read even in next test run (after exe finished)

UploadLogFileWithResults()

void AutotestRegister.UploadLogFileWithResults

(

)

If this is called it will automatically prepare "measurement file" which will upload console.log into.

Member Data Documentation

m_autotestPageName

string AutotestRegister.m_autotestPageName

protected

m_testIndex

int AutotestRegister.m_testIndex = 0

protected

This number serves to keep track of index of test we are running (usefull when we have multiple world files in single autotest)

m_worldFileFolder

string AutotestRegister.m_worldFileFolder

protected

---

The documentation for this interface was generated from the following file:

• GameLib/entities/autotest/AutotestRegister.c