sf::ResultDataTypes Class Reference

This base class contains all local types of used in the sf::ResultData class.
Multiple inheritance makes these types local for other classes as well.
Making code more readable and also prevents name space problems.
More...

#include <ResultDataTypes.h>

Inheritance diagram for sf::ResultDataTypes:

Collaboration diagram for sf::ResultDataTypes:

Classes
struct	Definition
	Structure used to setup a result reference. More...

Public Types
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.

Additional Inherited Members
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 base class contains all local types of used in the sf::ResultData class.
Multiple inheritance makes these types local for other classes as well.
Making code more readable and also prevents name space problems.

Member Typedef Documentation

PtrVector

typedef TVector<ResultData*> sf::ResultDataTypes::PtrVector

Vector for pointer to results.

ReferenceVector

typedef TVector<ResultDataReference*> sf::ResultDataTypes::ReferenceVector

Type for internal use.

Vector

typedef TVector<ResultData> sf::ResultDataTypes::Vector

Vector for instances of results.

Member Enumeration Documentation

EEvent

enum sf::ResultDataTypes::EEvent : int

Event enumerate values used in broadcasting where global events have a negative value.

Enumerator
reNewId	New ID was created.
reUserGlobal	First user global.
reFirstLocal	Indicates first local event.
reFlagsChange	Flags have been changed.
reAccessChange	Change in accessible range of this instance.
reCommitted	A range has been committed of this instance.
reReserve	Change of reserved blocks (always incremental).
reInvalid	Result reference is invalid after this event.
reClear	Current data will be cleared after this event.
reUserLocal	First user local event.
reFirstPrivate	Indicates first private event.
reSetup	This instance was set up.
reIdChanged	The instance's ID changed.
reDesiredId	This instance desired ID changed.
reRemove	Instance is being removed.
reGetOwner	Instance has become owner.
reLostOwner	Instance has lost ownership.
reLinked	Instance has been linked.
reUnlinked	Instance has lost link.
reGotRange	Clients receive this event when a request is answered.
reGetRange	The owner must get the data specified by the passed range.
reUserPrivate	First user private event.

EField

enum sf::ResultDataTypes::EField : int

This enumerate is the order of fields in the setup string.

Enumerator
rfId	Identifier field.
rfName	Name field.
rfFlags	Flags field.
rfDescription	description field.
rfType	Type string field See also EType
rfBlockSize	Size of the block in amount of types.
rfSegmentSize	Size of segment in blocks.
rfSigBits	Significant bits for this instance this can not be larger than the bit count of the type.
rfOffset	Negative offset of values. To get the real value clients must subtract this value from the read unsigned value.

EFlag

enum sf::ResultDataTypes::EFlag : flags_type

Flags of the flags description field.

Enumerator
flgRecycle	Represented by character 'R' only the owner can change set it.
flgArchive	Represented by character 'A' for clients to select instance for archiving data.
flgShare	Represented by character 'S' this data may be used by clients
flgHidden	Represented by character 'H' for selection of client only when listing.

ERangeInfo

enum sf::ResultDataTypes::ERangeInfo

Enumerate for range information bit values.

Enumerator
riAvailable	Range is available.
riAccessible	Range is fully accessible.
riPartialAccessible	Range is partial accessible.
riRequested	Range is already requested and the transaction id is returned in tranid
riAddressable	Range is addressable.
riSegmented	Range is spread over multiple segments.

EType

enum sf::ResultDataTypes::EType : int

This enumerate is used to identify the type of data.

Enumerator
rtInvalid	Invalid type indicating a faulty setup string represented by 'INVALID'.
rtString	Type containing a text represented by 'STRING'.
rtInt8	8 bit integers represented by 'INT8'.
rtInt16	16 bit integers represented by 'INT16'.
rtInt32	32 bit integers represented by 'INT32'.
rtInt64	64 bit integers represented by 'INT64'.
rtLastEntry	Used for iterations.

---

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

• ResultDataTypes.h