Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::RsaTypes::ResultInfo Struct Reference

#include <RsaTypes.h>

Collaboration diagram for sf::RsaTypes::ResultInfo:

Public Member Functions

 ResultInfo ()=default
 
void reset ()
 
 ResultInfo (const ResultInfo &pi)
 
ResultInfooperator= (const ResultInfo &pi)
 
ResultInfoCopy (const ResultInfo &pi)
 

Public Attributes

IdType Id {0}
 Holds a unique id for the current situation.
 
int Flags {0}
 Flags.
 
unsigned Gate {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.
 
unsigned Channel {0}
 Holds the channel number of this parameter. When channel is UINT_MAX the param is not a gate related param.
 
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.
 
int Offset {0}
 Level offset of the generated data.
 

Detailed Description

Structure to hold parameter information

Constructor & Destructor Documentation

◆ ResultInfo() [1/2]

sf::RsaTypes::ResultInfo::ResultInfo ( )
default

◆ ResultInfo() [2/2]

sf::RsaTypes::ResultInfo::ResultInfo ( const ResultInfo pi)
inline

Member Function Documentation

◆ Copy()

ResultInfo & sf::RsaTypes::ResultInfo::Copy ( const ResultInfo pi)
inline

◆ operator=()

ResultInfo & sf::RsaTypes::ResultInfo::operator= ( const ResultInfo pi)
inline

◆ reset()

void sf::RsaTypes::ResultInfo::reset ( )
inline

Member Data Documentation

◆ ArraySize

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

Amount of values in an array for an arrayed value.

◆ Bits

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

Amount of Bits used to store the actual value.

◆ Channel

unsigned sf::RsaTypes::ResultInfo::Channel {0}

Holds the channel number of this parameter. When channel is UINT_MAX the param is not a gate related param.

◆ Description

std::string sf::RsaTypes::ResultInfo::Description

Usage off the parameter of the parameter.

◆ Flags

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

Flags.

◆ Gate

unsigned sf::RsaTypes::ResultInfo::Gate {0}

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

◆ Id

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

Holds a unique id for the current situation.

◆ Index

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

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

◆ Name

std::string sf::RsaTypes::ResultInfo::Name

Name of the parameter.

◆ Offset

int sf::RsaTypes::ResultInfo::Offset {0}

Level offset of the generated data.

◆ WordSize

unsigned sf::RsaTypes::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: