Integer Class Reference

integer variable More...

#include <Integer.h>

Inheritance diagram for Integer:

Public Member Functions

 Integer (const std::string &tag, const std::string &description, int value, Persistent *parent=nullptr)
 main constructor More...
 
Integeroperator= (const int &rhs)
 assign from int More...
 
 Integer (Integer &&other)
 move constructor More...
 
Integeroperator= (Integer &&other)
 move assignment More...
 
const std::string & type () const override
 
void increment (unsigned int i=1)
 increase by i the value of the Integer; i must be positive More...
 
void decrement (unsigned int i=1)
 decrease by i the value of the Integer; i must be positive More...
 
- Public Member Functions inherited from Type< int >
 Type (const std::string &tag, const std::string &description, Persistent *parent, const int &value)
 main constructor More...
 
 Type (Type &&other)
 move constructor More...
 
Typeoperator= (Type &&other)
 move assignment More...
 
int & value (void)
 Type value getter. More...
 
const int & value (void) const
 
bool operator!= (const Type &rhs) const
 
bool operator== (const Type &rhs) const
 
- Public Member Functions inherited from Item
 Item (const Item &other)
 copy constructor copies all elements but parent which is set to nullptr More...
 
Itemoperator= (const Item &other)
 copy assignment operator copies all elements but parent which is set to nullptr More...
 
 Item (const std::string &tag, const std::string &description, Persistent *parent)
 
 Item (Item &&other)
 move constructor More...
 
Itemoperator= (Item &&other)
 move assignment operator More...
 
virtual ~Item ()
 
const std::string & tag () const
 
const std::string & description () const
 
std::string fullTag () const
 
const Persistentparent () const
 
virtual const std::string & type () const =0
 
void setTag (const std::string &tag)
 
void setDescription (const std::string &description)
 
void setWideTag (const std::wstring &tag)
 wide-character variant, More...
 
void setWideDescription (const std::wstring &description)
 wide-character variant, More...
 
bool operator!= (const Item &rhs) const
 
bool operator== (const Item &rhs) const
 

Additional Inherited Members

- Public Types inherited from Type< int >
typedef int ValueType
 name the value type to make it possible for function templates acting on Type<T> to access T properties and methods More...
 
- Protected Attributes inherited from Type< int >
int value_
 
- Protected Attributes inherited from Item
Persistentparent_
 pointer to the parent Persistent; set to this by the constructor if Item is self-standing or a root Persistent of a tree More...
 

Detailed Description

integer variable

used for configuration parameters (nStreams), error numbers (nErrors, nWarnings) etc.

#include <libpf/persistency/Integer.h>

Remarks
Warning
Thread safe:
Extendable:
Platform dependencies:

Constructor & Destructor Documentation

◆ Integer() [1/2]

Integer::Integer ( const std::string &  tag,
const std::string &  description,
int  value,
Persistent parent = nullptr 
)
inline

main constructor

◆ Integer() [2/2]

Integer::Integer ( Integer &&  other)
inline

move constructor

Member Function Documentation

◆ decrement()

void Integer::decrement ( unsigned int  i = 1)

decrease by i the value of the Integer; i must be positive

◆ increment()

void Integer::increment ( unsigned int  i = 1)

increase by i the value of the Integer; i must be positive

◆ operator=() [1/2]

Integer & Integer::operator= ( const int &  rhs)

assign from int

◆ operator=() [2/2]

Integer & Integer::operator= ( Integer &&  other)
inline

move assignment

◆ type()

const std::string & Integer::type ( ) const
overridevirtual
Returns
the C++ name of the class the instance belongs to
Note
it is the responsibility of the caller to not access this reference after the lifecycle of the Item

Implements Item.


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