FFrVariable Class Reference

Class representing a physical variable in the result file hierarchy. More...

#include <FFrVariable.H>

Classes
struct	Less
	Functor for comparison of two variable definitions. More...

Public Types
enum	VDType {   NONE , CHAR , UCHAR , INT ,   UINT , FLOAT }
	Enum defining available the variable types. More...

Public Member Functions
	FFrVariable ()
	Default constructor initializing the members. More...
int	fillObject (const std::vector< std::string > &tokens)
	Parses the variable definition from a list of strings. More...
void	dump (std::ostream &os=std::cout) const
	Prints the variable defintion to the sepcified output stream. More...
size_t	getTotalDataSize () const
	Returns the total number of bits in the variable. More...
size_t	getRepeats () const
	Returns the total number of words in the variable. More...
bool	equal (const FFrVariable *that) const
	Return true if *this equals *that. More...
bool	less (const FFrVariable *that) const
	Return true if *this is less than *that. More...

Static Public Member Functions
static FFrStatus	create (FILE *varStream, FFrCreatorData &cd, bool dataBlocks)
	Static method for parsing a variable definition from file. More...

Public Attributes
std::string	name
	Name or desription of the variable. More...
std::string	unit
	Unit of the variable (only for FLOAT variables) More...
VDTypeEnum	dataType
	Basic data type of the variable. More...
std::string	dataClass
	Class name (structured type) of the variable. More...
size_t	dataSize
	Size (in bits) of each word of the variable. More...
size_t	repeats
	Total number of words in the variable. More...
std::vector< size_t >	dataBlockSizes
	Number of data words in each direction for multi-dimensional variables. More...
std::vector< std::string >	dataBlockDescription
	Component names for multi-dimensional variables. More...

Detailed Description

Class representing a physical variable in the result file hierarchy.

Member Enumeration Documentation

VDType

enum FFrVariable::VDType

Enum defining available the variable types.

Enumerator
NONE	None - undefined.
CHAR	Signed character.
UCHAR	Unsigned character.
INT	Signed integer.
UINT	Unsigned integer.
FLOAT	Real, either single or double precision (float or double)

Constructor & Destructor Documentation

FFrVariable()

FFrVariable::FFrVariable ( )

inline

Default constructor initializing the members.

Member Function Documentation

create()

FFrStatus FFrVariable::create ( FILE *  varStream, FFrCreatorData &  cd, bool  dataBlocks  )

static

Static method for parsing a variable definition from file.

If the parsing succedes, a new FFrVariable instance is created and inserted into the the container cd, unless a matching entry already exists. The method may also detect references to variable and then creates a FFrVariableReference for it.

dump()

void FFrVariable::dump

(

std::ostream &

os = std::cout

)

const

Prints the variable defintion to the sepcified output stream.

equal()

bool FFrVariable::equal

(

const FFrVariable *

that

)

const

Return true if *this equals *that.

fillObject()

int FFrVariable::fillObject

(

const std::vector< std::string > &

tokens

)

Parses the variable definition from a list of strings.

getRepeats()

size_t FFrVariable::getRepeats ( ) const

inline

Returns the total number of words in the variable.

getTotalDataSize()

size_t FFrVariable::getTotalDataSize ( ) const

inline

Returns the total number of bits in the variable.

less()

bool FFrVariable::less

(

const FFrVariable *

that

)

const

Return true if *this is less than *that.

Member Data Documentation

dataBlockDescription

std::vector<std::string> FFrVariable::dataBlockDescription

Component names for multi-dimensional variables.

dataBlockSizes

std::vector<size_t> FFrVariable::dataBlockSizes

Number of data words in each direction for multi-dimensional variables.

dataClass

std::string FFrVariable::dataClass

Class name (structured type) of the variable.

dataSize

size_t FFrVariable::dataSize

Size (in bits) of each word of the variable.

dataType

VDTypeEnum FFrVariable::dataType

Basic data type of the variable.

name

std::string FFrVariable::name

Name or desription of the variable.

repeats

size_t FFrVariable::repeats

Total number of words in the variable.

unit

std::string FFrVariable::unit

Unit of the variable (only for FLOAT variables)

---

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

• fedem-foundation/src/FFrLib/FFrVariable.H
• fedem-foundation/src/FFrLib/FFrVariable.C