sf::ResultDataReference Struct Reference

#include <ResultDataReference.h>

Inheritance diagram for sf::ResultDataReference:

Collaboration diagram for sf::ResultDataReference:

Public Member Functions
	ResultDataReference ()
	Default constructor.
	~ResultDataReference ()
	Destructor.

Public Attributes
id_type	_id {0}
	contains the ID of the result data.
id_type	_sequenceId {0}
	contains the sequential ID of the result data.
bool	_valid {false}
	Flag if this instance is valid.
EType	_type {rtInvalid}
	contains the type of data of the result.
data_type	_offset {0}
	contains the correction offset for each value to get the real value.
size_type	_significantBits {0}
	contains the type of data of the result.
flags_type	_flags {0}
	Member that contains the initial flags of the setup.
flags_type	_curFlags {rtInvalid}
	Member that contains the current flags of the setup.
std::string	_name
	contains the name string of the result data.
std::string	_description
	contains the description string of the result data.
bool	_debug {false}
	Flag for debugging output.
FileMappedStorage *	_data {nullptr}
	Container for segments of data.
RangeManager *	_rangeManager {nullptr}
	Range manager for accessible entries.
Range::Vector	_validatedCache
	Vector containing ranges which are validated by the owner.
PtrVector	_list

Additional Inherited Members
Public Types inherited from sf::ResultDataTypes
enum	EEvent : int {   reNewId = -32000 , reUserGlobal , reFirstLocal = 0 , reFlagsChange ,   reAccessChange , reCommitted , reReserve , reInvalid ,   reClear , reUserLocal , reFirstPrivate = 16000 , reSetup ,   reIdChanged , reDesiredId , reRemove , reGetOwner ,   reLostOwner , reLinked , reUnlinked , reGotRange ,   reGetRange , reUserPrivate }
	Event enumerate values used in broadcasting where global events have a negative value. More...
enum	EField : int {   rfId = 0 , rfName , rfFlags , rfDescription ,   rfType , rfBlockSize , rfSegmentSize , rfSigBits ,   rfOffset }
	This enumerate is the order of fields in the setup string. More...
enum	EType : int {   rtInvalid = 0 , rtString , rtInt8 , rtInt16 ,   rtInt32 , rtInt64 , rtLastEntry }
	This enumerate is used to identify the type of data. More...
enum	EFlag : flags_type { flgRecycle = 1 << 0 , flgArchive = 1 << 1 , flgShare = 1 << 2 , flgHidden = 1 << 3 }
	Flags of the flags description field. More...
enum	ERangeInfo {   riAvailable = 1 << 0 , riAccessible = 1 << 1 , riPartialAccessible = 1 << 2 , riRequested = 1 << 3 ,   riAddressable = 1 << 5 , riSegmented = 1 << 4 }
	Enumerate for range information bit values. More...
typedef TVector< ResultData * >	PtrVector
	Vector for pointer to results.
typedef TVector< ResultData >	Vector
	Vector for instances of results.
typedef TVector< ResultDataReference * >	ReferenceVector
	Type for internal use.
Public Types inherited from sf::InformationTypes
typedef unsigned long long	id_type
	Type used for the identifying integer (64-bits).
typedef int32_t	flags_type
	Type used for the flag integer.
typedef size_t	size_type
	Type used for size of vectors.
typedef ssize_t	ssize_type
	Same as size_type but a signed version.
typedef uintptr_t	data_type
	Type used for containing a single data element which is the largest integer.
typedef intptr_t	sdata_type
	Type used for containing a single data element which is the largest signed integer.
typedef TVector< id_type >	IdVector
	Vector for lists of information ID's.
typedef TVector< InformationBase * >	Vector
	Vector for containing different information base derived classes.
Static Public Member Functions inherited from sf::InformationTypes
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)), data_type >	toDataType (T value)
	Casts any type to a data_type value.
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)||std::is_reference_v< T >), T >	fromDataType (data_type value)
	Casts a data_type value to a given type. Reference types are also possible since they are the same size as a pointer underwater.
Static Public Attributes inherited from sf::InformationTypes
static constexpr size_t	npos = std::numeric_limits<size_type>::max()
	Unsigned size value indicating not found or no index.

Detailed Description

This structure is referenced by class TResultData. Several TResultData instances can reference to one TResultDataReference instance. Only one TResultDataReference can exist per ID.

Constructor & Destructor Documentation

ResultDataReference()

sf::ResultDataReference::ResultDataReference

(

)

Default constructor.

~ResultDataReference()

sf::ResultDataReference::~ResultDataReference

(

)

Destructor.

Member Data Documentation

_curFlags

flags_type sf::ResultDataReference::_curFlags {rtInvalid}

Member that contains the current flags of the setup.

_data

FileMappedStorage* sf::ResultDataReference::_data {nullptr}

Container for segments of data.

_debug

bool sf::ResultDataReference::_debug {false}

Flag for debugging output.

_description

std::string sf::ResultDataReference::_description

contains the description string of the result data.

_flags

flags_type sf::ResultDataReference::_flags {0}

Member that contains the initial flags of the setup.

_id

id_type sf::ResultDataReference::_id {0}

contains the ID of the result data.

_list

PtrVector sf::ResultDataReference::_list

List of result data instances attached to this reference.

_name

std::string sf::ResultDataReference::_name

contains the name string of the result data.

_offset

data_type sf::ResultDataReference::_offset {0}

contains the correction offset for each value to get the real value.

_rangeManager

RangeManager* sf::ResultDataReference::_rangeManager {nullptr}

Range manager for accessible entries.

_sequenceId

id_type sf::ResultDataReference::_sequenceId {0}

contains the sequential ID of the result data.

_significantBits

size_type sf::ResultDataReference::_significantBits {0}

contains the type of data of the result.

_type

EType sf::ResultDataReference::_type {rtInvalid}

contains the type of data of the result.

_valid

bool sf::ResultDataReference::_valid {false}

Flag if this instance is valid.

_validatedCache

Range::Vector sf::ResultDataReference::_validatedCache

Vector containing ranges which are validated by the owner.

---

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

• ResultDataReference.h