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

Abstract class to store information id's in a configuration string. Used to be implemented twice, one as the actual containing and the other containing only the id's. More...

#include <InformationIds.h>

Inheritance diagram for sf::InformationIds:
Collaboration diagram for sf::InformationIds:

Public Member Functions

 InformationIds ()
 Default constructor setting the use of hexadecimals by default.
 
 TTypedList ()=default
 Default constructor.
 
- Public Member Functions inherited from sf::TTypedList< InformationTypes::id_type >
 TTypedList ()=default
 Default constructor.
 
virtual ~TTypedList ()=default
 Virtual destructor.
 
virtual ssize_t add (const value_type &value)
 Adds an integer to the end of the list.
 
void assign (std::initializer_list< value_type > list)
 Assigns a list of values to the list.
 
void assign (const TTypedList &other)
 Assign the values from the other typed list.
 
virtual void exchange (index_type from_index, index_type to_index)
 Swap underling index positions.
 
void clear ()
 Clears the all items from the store.
 
virtual void remove (index_type index, index_type sz)
 Removes the item at the position given by the index argument. When the underlying list is static do not implement.
 
bool isEqual (const TTypedList &other) const
 Compares the other list with this one.
 
bool operator== (const TTypedList &other) const
 Equal operator calling isEqual().
 
bool operator!= (const TTypedList &other) const
 Equal operator calling isEqual().
 
index_type indexOf (const value_type &value) const
 Gets the found index of the given value in the list.
 
void set (index_type index, const value_type &value)
 Sets an entry value using the given index position.
 
value_type get (index_type index) const
 Gets the const entry reference from the given index position.
 
value_type operator[] (index_type index) const
 Const array operator calling get().
 
virtual index_type size () const=0
 Gets the size of the underlying data store.
 
virtual void resize (index_type)
 Resizes the underlying store. When the store is static do not override it.
 
std::string toString (const std::string &separator={}) const
 Gets the values as a string separated by the given separator.
 
void fromString (const std::string &str, value_type def={}, const std::string &separator={})
 Gets the values as a string separated by the given separator.
 
virtual void beginChange ()
 Enables to track when the list of strings is changing. Can be overloaded when needed for change event optimization.
 
virtual void endChange ()
 Enables the to keep track of when the list has finished changing. Can be overloaded when needed for change event optimization.
 

Additional Inherited Members

- Public Types inherited from sf::TTypedList< InformationTypes::id_type >
typedef ssize_t index_type
 Type of the indices used by this class.
 
typedef InformationTypes::id_type value_type
 Type of the stored values.
 
- Public Attributes inherited from sf::TTypedList< InformationTypes::id_type >
TClosure< void, void * > onChanging
 Event callback function for when a change is about to happen.
 
TClosure< void, void * > onChanged
 Event callback function for when a change is done.
 
- Static Public Attributes inherited from sf::TTypedList< InformationTypes::id_type >
static constexpr index_type npos
 Value for no index position.
 
- Protected Member Functions inherited from sf::TTypedList< InformationTypes::id_type >
void checkIndex (index_type index) const
 Checks the validity of the passed index and when not valid throws an exception.
 
virtual value_type store (index_type index, const value_type *value=nullptr)=0
 Handles Accesses the actual store.
 
void setHexadecimal (bool flag)
 Enables integral types as hexadecimals in the string from toString() function.
 

Detailed Description

Abstract class to store information id's in a configuration string. Used to be implemented twice, one as the actual containing and the other containing only the id's.

Constructor & Destructor Documentation

◆ InformationIds()

sf::InformationIds::InformationIds ( )
inline

Default constructor setting the use of hexadecimals by default.

Member Function Documentation

◆ TTypedList()

sf::TTypedList< T, S >::TTypedList ( )
default

Default constructor.


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