Result Class Reference

Representation of all the results and their components read from a res file. More...

#include <result.h>

Public Member Functions
	Result (gzFile file, dataFields fields, int componentCount)
std::string	getAnalysis ()
std::string	getResultType ()
float	getStep () const
int	getComponentCount () const
unsigned int	getValuesCount () const
std::vector< std::string >	getComponents ()
std::tuple< int &, float * >	getResult (const unsigned int &id)

Private Member Functions
void	readComponents (gzFile file, char buffer[GZ_BUFFER_SIZE], dataFields fields)
	Write the result into a currently open PostResultFile. More...
void	readResults (gzFile file, char buffer[GZ_BUFFER_SIZE])

Private Attributes
std::string	analysis
	Type of analysis. More...
std::string	result
	Type of results. More...
float	step
	Time step inside the analysis. More...
int	componentCount
	Number of components of the result. More...
unsigned int	valuesCount
	Number of values read. More...
std::vector< std::string >	components
	Components of the result (size = componentCount) More...
int *	nodeIDs
	List of IDs of the nodes involved in the result. More...
float *	values
	Values of the result. More...

Detailed Description

Representation of all the results and their components read from a res file.

Constructor & Destructor Documentation

Result()

Result::Result	(	gzFile	file,
		dataFields	fields,
		int	componentCount
	)

Parameters

file	res gzFile
fields	Base fields read from the file
componentCount	Number of component to seek into the result data

Member Function Documentation

getAnalysis()

std::string Result::getAnalysis

(

)

Returns

The type of analysis of the result

getComponentCount()

int Result::getComponentCount

(

)

const

Returns

The number component of the result (1 or 4)

getComponents()

std::vector< std::string > Result::getComponents

(

)

Returns

The components of the result (X, Y, Z, M)

getResult()

std::tuple< int &, float * > Result::getResult

(

const unsigned int &

id

)

Parameters

id	ID of the result

Returns

Return information about the result

getResultType()

std::string Result::getResultType

(

)

Returns

The type of result

getStep()

float Result::getStep

(

)

const

Returns

Step of the result

getValuesCount()

unsigned int Result::getValuesCount

(

)

const

Returns

The number of values of the result

readComponents()

void Result::readComponents ( gzFile  file, char  buffer[GZ_BUFFER_SIZE], dataFields  fields  )

private

Write the result into a currently open PostResultFile.

Returns

The state of the GiD Post Result closure Read the result components from the mesh file

Parameters

file	File that contains the result and meshes information
buffer	The zlib reading buffer from previous gzread
fields	Base fields read from the file

readResults()

void Result::readResults ( gzFile  file, char  buffer[GZ_BUFFER_SIZE]  )

private

Read the results values from the res file

Parameters

file	File that contains the result information
buffer	Thz zlib reading buffer from previous gzread

Member Data Documentation

analysis

std::string Result::analysis

private

Type of analysis.

componentCount

int Result::componentCount

private

Number of components of the result.

components

std::vector<std::string> Result::components

private

Components of the result (size = componentCount)

nodeIDs

int* Result::nodeIDs

private

List of IDs of the nodes involved in the result.

result

std::string Result::result

private

Type of results.

step

float Result::step

private

Time step inside the analysis.

values

float* Result::values

private

Values of the result.

valuesCount

unsigned int Result::valuesCount

private

Number of values read.

---

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

• include/core/result.h
• src/core/result.cpp