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

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

#include <VariableStatic.h>

Inheritance diagram for sf::VariableStatic:
Collaboration diagram for sf::VariableStatic:

Static Public Member Functions

static Variablezero ()
 Returns Variable instance 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.
 

Friends

class Variable
 
class VariableReference
 

Additional Inherited Members

- Public Types inherited from sf::VariableTypes
enum  EEvent : int {
  veConvert = 64000 , veNewId = -32000 , veUserGlobal , veFirstLocal = 0 ,
  veFlagsChange = 1 , veValueChange = 2 , veInvalid = 3 , veConverted = 4 ,
  veUserLocal = 5 , veFirstPrivate = 16000 , veIdChanged = 16001 , veDesiredId = 16002 ,
  veRemove = 16003 , veGetOwner = 16004 , veLostOwner = 16005 , veLinked = 16006 ,
  veUnlinked = 16007 , veSetup = 16008 , veUserPrivate = 16009
}
 Events send to the handler set with sf::Variable::setHandler. More...
 
enum  EField : int {
  vfId = 0 , vfName , vfUnit , vfFlags ,
  vfDescription , vfType , vfConversionType , vfRound ,
  vfDefault , vfMinimum , vfMaximum , vfFirstState
}
 
enum  EFlag : flags_type {
  flgReadonly = 1 << 0 , flgArchive = 1 << 1 , flgShare = 1 << 2 , flgLink = 1 << 3 ,
  flgFunction = 1 << 4 , flgParameter = 1 << 5 , flgHidden = 1 << 6 , flgExport = 1 << 7 ,
  flgWriteable = 1 << 8
}
 
enum  EStringType : int {
  stNoString = -1 , stNormal = 0 , stMulti , stPath ,
  stDirectory , stFilename , stSubdirectory
}
 
typedef TVector< Variable * > PtrVector
 Vector for pointers to variables.
 
typedef TVector< VariableVector
 Vector for instances of variables.
 
typedef TVector< VariableReference * > ReferenceVector
 Types 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.
 
- 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::Variable having all global static data members.

Member Function Documentation

◆ initialize()

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

Called to initialize or uninitialize the variable system.

◆ zero()

static Variable & sf::VariableStatic::zero ( )
static

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

Friends And Related Symbol Documentation

◆ Variable

friend class Variable
friend

Type of the id is a variable.

◆ VariableReference

friend class VariableReference
friend

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