Results Manager Functions

This group is for functions included in the Results Manager. The Results Manager stores analysis results and provides methods to get, print, and export them.

Click here to return to the main page. More...

Functions
int	GetNumResults (const string &in name)
string	GetResultsName (const string &in results_id)
string	FindResultsID (const string &in name, int index=0)
string	FindLatestResultsID (const string &in name)
int	GetNumData (const string &in results_id, const string &in data_name)
int	GetResultsType (const string &in results_id, const string &in data_name)
string []	GetAllResultsNames ()
string []	GetAllDataNames (const string &in results_id)
int []	GetIntResults (const string &in id, const string &in name, int index=0)
double []	GetDoubleResults (const string &in id, const string &in name, int index=0)
double [][]	GetDoubleMatResults (const string &in id, const string &in name, int index=0)
string []	GetStringResults (const string &in id, const string &in name, int index=0)
vec3d []	GetVec3dResults (const string &in id, const string &in name, int index=0)
string	CreateGeomResults (const string &in geom_id, const string &in name)
void	DeleteAllResults ()
void	DeleteResult (const string &in id)
void	WriteResultsCSVFile (const string &in id, const string &in file_name)
void	PrintResults (const string &in id)
void	WriteTestResults ()

Detailed Description

Function Documentation

CreateGeomResults()

string CreateGeomResults	(	const string &in	geom_id,
		const string &in	name
	)

Create a new result for a Geom

Parameters

[in]	geom_id	Geom ID
[in]	name	Result name

Returns

Result ID

DeleteAllResults()

void DeleteAllResults

(

)

Delete all results

DeleteResult()

void DeleteResult

(

const string &in

id

)

Delete a particular result

Parameters

[in]

id

Result ID

FindLatestResultsID()

string FindLatestResultsID

(

const string &in

name

)

Find the latest results ID for particular result name

Parameters

[in]

name

Result name

Returns

Result ID

FindResultsID()

string FindResultsID	(	const string &in	name,
		int	index = 0
	)

Find a results ID given its name and index

Parameters

[in]	name	Result name
[in]	index	Result index

Returns

Result ID

GetAllDataNames()

string [] GetAllDataNames

(

const string &in

results_id

)

Get all data names for a particular result

Parameters

[in]

results_id

Result ID

Returns

Array of result names

GetAllResultsNames()

string [] GetAllResultsNames

(

)

Get the name of all results in the Results Manager

Returns

Array of result names

GetDoubleMatResults()

double [][] GetDoubleMatResults	(	const string &in	id,
		const string &in	name,
		int	index = 0
	)

Get all matrix (vector<vector<double>>) values for a particular result, name, and index

Parameters

[in]	id	Result ID
[in]	name	Data name
[in]	index	Data index

Returns

2D array of data values

GetDoubleResults()

double [] GetDoubleResults	(	const string &in	id,
		const string &in	name,
		int	index = 0
	)

Get all double values for a particular result, name, and index

Parameters

[in]	id	Result ID
[in]	name	Data name
[in]	index	Data index

Returns

Array of data values

GetIntResults()

int [] GetIntResults	(	const string &in	id,
		const string &in	name,
		int	index = 0
	)

Get all integer values for a particular result, name, and index

Parameters

[in]	id	Result ID
[in]	name	Data name
[in]	index	Data index

Returns

Array of data values

GetNumData()

int GetNumData	(	const string &in	results_id,
		const string &in	data_name
	)

Get the number of data values for a given result ID and data name

Parameters

[in]	results_id	Result ID
[in]	data_name	Data name

Returns

Number of data values

GetNumResults()

int GetNumResults

(

const string &in

name

)

Get the number of results for a particular result name

Parameters

[in]

name

Input name

Returns

Number of results

GetResultsName()

string GetResultsName

(

const string &in

results_id

)

Get the name of a result given its ID

Parameters

[in]

results_id

Result ID

Returns

Result name

GetResultsType()

int GetResultsType	(	const string &in	results_id,
		const string &in	data_name
	)

Get the data type for a given result ID and data name

See also

RES_DATA_TYPE

Parameters

[in]	results_id	Result ID
[in]	data_name	Data name

Returns

Data type enum (i.e. DOUBLE_DATA)

GetStringResults()

string [] GetStringResults	(	const string &in	id,
		const string &in	name,
		int	index = 0
	)

Get all string values for a particular result, name, and index

Parameters

[in]	id	Result ID
[in]	name	Data name
[in]	index	Data index

Returns

Array of data values

GetVec3dResults()

vec3d [] GetVec3dResults	(	const string &in	id,
		const string &in	name,
		int	index = 0
	)

Get all vec3d values for a particular result, name, and index

Parameters

[in]	id	Result ID
[in]	name	Data name
[in]	index	Data index

Returns

Array of data values

PrintResults()

void PrintResults

(

const string &in

id

)

Print a result's name value pairs to stdout

Parameters

[in]

id

Result ID

WriteResultsCSVFile()

void WriteResultsCSVFile	(	const string &in	id,
		const string &in	file_name
	)

Export a result to CSV

Parameters

[in]	id	Rsult ID
[in]	file_name	CSV output file name

WriteTestResults()

void WriteTestResults

(

)

Perform a simple data type test and print results to stdout