sf::gmi::ResultInfo Struct Reference

Structure to hold parameter information. More...

#include <GmiInterface.h>

Collaboration diagram for sf::gmi::ResultInfo:

Public Member Functions
	ResultInfo ()=default
	ResultInfo (const ResultInfo &pi)
ResultInfo &	operator= (const ResultInfo &pi)
void	init ()
ResultInfo &	copy (const ResultInfo &pi)

Public Attributes
IdType	Id {0}
	Holds a unique id for the current situation.
int	Flags {0}
	Flags.
unsigned	Axis {0}
	Holds the gate number this gate belongs to. When gate is UINT_MAX the param is not a gate related param.
unsigned	Index {0}
	Param index in the hierarchy of the gate or non gate params.
std::string	Name
	Name of the parameter.
std::string	Description
	Usage off the parameter of the parameter.
unsigned	Bits {0}
	Amount of Bits used to store the actual value.
unsigned	WordSize {0}
	Amount of bytes 1, 2 or 4 (later 8) used for storing a single value.
unsigned	ArraySize {0}
	Amount of values in an array for an arrayed value.

Detailed Description

Structure to hold parameter information.

Constructor & Destructor Documentation

ResultInfo() [1/2]

sf::gmi::ResultInfo::ResultInfo ( )

default

ResultInfo() [2/2]

sf::gmi::ResultInfo::ResultInfo ( const ResultInfo &  pi )

inline

Member Function Documentation

copy()

ResultInfo & sf::gmi::ResultInfo::copy

(

const ResultInfo &

pi

)

init()

void sf::gmi::ResultInfo::init

(

)

operator=()

ResultInfo & sf::gmi::ResultInfo::operator= ( const ResultInfo &  pi )

inline

Member Data Documentation

ArraySize

unsigned sf::gmi::ResultInfo::ArraySize {0}

Amount of values in an array for an arrayed value.

Axis

unsigned sf::gmi::ResultInfo::Axis {0}

Holds the gate number this gate belongs to. When gate is UINT_MAX the param is not a gate related param.

Bits

unsigned sf::gmi::ResultInfo::Bits {0}

Amount of Bits used to store the actual value.

Description

std::string sf::gmi::ResultInfo::Description

Usage off the parameter of the parameter.

Flags

int sf::gmi::ResultInfo::Flags {0}

Flags.

Id

IdType sf::gmi::ResultInfo::Id {0}

Holds a unique id for the current situation.

Index

unsigned sf::gmi::ResultInfo::Index {0}

Param index in the hierarchy of the gate or non gate params.

Name

std::string sf::gmi::ResultInfo::Name

Name of the parameter.

WordSize

unsigned sf::gmi::ResultInfo::WordSize {0}

Amount of bytes 1, 2 or 4 (later 8) used for storing a single value.

---

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

• GmiInterface.h