Scanframe Modular Application 0.1.0
Loading...
Searching...
No Matches
sf::ResultDataStatic Class Reference

Base class of the sf::ResultData having all global static data members. More...

#include <ResultDataStatic.h>

Inheritance diagram for sf::ResultDataStatic:
Collaboration diagram for sf::ResultDataStatic:

Static Public Member Functions

static ResultDatazero ()
 Result that always exist in the system and is referenced if no other is available or applicable.
 
static void initialize (bool)
 Called to initialize or uninitialize the variable system.
 
static EType getType (std::string_view type)
 Gets the enumerate type from the passed type string.
 
static size_type getUniqueId ()
 

Friends

class ResultData
 
class ResultDataReference
 

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< ResultDataVector
 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 uint64_t data_type
 Type used for containing a single data element which is the largest integer.
 
typedef int64_t sdata_type
 Type used for containing a single data element which is the largest signed integer.
 
typedef TVector< id_typeIdVector
 Vector for lists of information ID's.
 
typedef TVector< InformationBase * > Vector
 Vector for containing different information base derived classes.
 
- Public Member Functions inherited from sf::InformationTypes
template<typename T >
constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)), data_typetoDataType (T value) const
 Casts any type to a data_type value.
 
template<typename T >
constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)), T > fromDataType (data_type value) const
 Casts a data_type value to a given type.
 
- 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

Base class of the sf::ResultData having all global static data members.

Member Function Documentation

◆ getType()

static EType sf::ResultDataStatic::getType ( std::string_view  type)
static

Gets the enumerate type from the passed type string.

◆ getUniqueId()

static size_type sf::ResultDataStatic::getUniqueId ( )
static

Gets a number which is unique because it is incremented at each call.

Returns
Unique id number.

◆ initialize()

static void sf::ResultDataStatic::initialize ( bool  )
static

Called to initialize or uninitialize the variable system.

◆ zero()

static ResultData & sf::ResultDataStatic::zero ( )
static

Result that always exist in the system and is referenced if no other is available or applicable.

Friends And Related Symbol Documentation

◆ ResultData

friend class ResultData
friend

Type of the id is a result-data.

◆ ResultDataReference

friend class ResultDataReference
friend

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