sf::InformationIdList Class Reference

Manages a vector InformationTypes::IdVector. This instance can be used to assign to a sf::VariableIdList instance. More...

#include <InformationIdList.h>

Inheritance diagram for sf::InformationIdList:

Collaboration diagram for sf::InformationIdList:

Public Member Functions
	InformationIdList ()
	< Inherit constructors and destructor from the base class.
	InformationIdList (InformationTypes::IdVector &ids)
	Initializing constructor using a not owned vector.
	~InformationIdList () override
	Destructor cleaning owned vector,.
void	remove (index_type index, index_type sz) override
	Overridden from base class InformationIds.
index_type	size () const override
	Overridden from base class InformationIds.
void	resize (index_type) override
	Overridden from base class InformationIds.
InformationTypes::IdVector &	getIds ()
	Gets the reference to the vector store of this instance.
	InformationIds ()
	Default constructor setting the use of hexadecimals by default.
Public Member Functions inherited from sf::InformationIds
	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.
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().
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.

Protected Member Functions
value_type	store (index_type index, const value_type *value) override
	Overridden from base class to handel read and writes of values.
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.
void	setHexadecimal (bool flag)
	Enables integral types as hexadecimals in the string from toString() function.

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.

Detailed Description

Manages a vector InformationTypes::IdVector. This instance can be used to assign to a sf::VariableIdList instance.

Constructor & Destructor Documentation

InformationIdList() [1/2]

sf::InformationIdList::InformationIdList

(

)

< Inherit constructors and destructor from the base class.

Default constructor create a self owned id vector.

InformationIdList() [2/2]

sf::InformationIdList::InformationIdList ( InformationTypes::IdVector &  ids )

explicit

Initializing constructor using a not owned vector.

~InformationIdList()

sf::InformationIdList::~InformationIdList ( )

override

Destructor cleaning owned vector,.

Member Function Documentation

getIds()

InformationTypes::IdVector & sf::InformationIdList::getIds

(

)

Gets the reference to the vector store of this instance.

Returns

InformationIds()

sf::InformationIds::InformationIds ( )

inline

Default constructor setting the use of hexadecimals by default.

remove()

void sf::InformationIdList::remove ( index_type  index, index_type  sz  )

overridevirtual

Overridden from base class InformationIds.

Reimplemented from sf::TTypedList< InformationTypes::id_type >.

resize()

void sf::InformationIdList::resize ( index_type  )

overridevirtual

Overridden from base class InformationIds.

Reimplemented from sf::TTypedList< InformationTypes::id_type >.

size()

index_type sf::InformationIdList::size ( ) const

overridevirtual

Overridden from base class InformationIds.

Implements sf::TTypedList< InformationTypes::id_type >.

store()

value_type sf::InformationIdList::store ( index_type  index, const value_type *  value  )

overrideprotectedvirtual

Overridden from base class to handel read and writes of values.

Implements sf::TTypedList< InformationTypes::id_type >.

---

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

• InformationIdList.h