Class handling. More...

#include <VariableIdList.h>

Inheritance diagram for sf::VariableIdList:

[legend]

Collaboration diagram for sf::VariableIdList:

[legend]

Public Types
typedef InformationIds	Inherited
	For referencing types from the base class.

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 Member Functions
	VariableIdList (const Variable::PtrVector &list)
	Constructor assigning a Variable pointer typed vector.

	VariableIdList (const Variable::Vector &list)
	Constructor assigning a Variable typed vector.

index_type	size () const override
	Gets the size of the underlying store.

void	setTemporary (bool)
	Makes existing variables have temporary values. New created sf::Variable instances are set accordingly.

void	setGlobal (bool)
	Makes existing variables global or not. New created sf::Variable instances are set accordingly.

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.

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 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 overridden when needed for change event optimization.

virtual void	endChange ()
	Enables the to keep track of when the list has finished changing. Can be overridden 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 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

Class handling.

Member Typedef Documentation

◆ Inherited

typedef InformationIds sf::VariableIdList::Inherited

For referencing types from the base class.

Constructor & Destructor Documentation

◆ VariableIdList() [1/2]

sf::VariableIdList::VariableIdList ( const Variable::PtrVector & list )

explicit

Constructor assigning a Variable pointer typed vector.

Parameters

list	Vector of Variable pointers.

◆ VariableIdList() [2/2]

sf::VariableIdList::VariableIdList ( const Variable::Vector & list )

explicit

Constructor assigning a Variable typed vector.

Parameters

list	Vector of Variable.

Member Function Documentation

◆ setGlobal()

void sf::VariableIdList::setGlobal ( bool )

Makes existing variables global or not. New created sf::Variable instances are set accordingly.

◆ setTemporary()

void sf::VariableIdList::setTemporary ( bool )

Makes existing variables have temporary values. New created sf::Variable instances are set accordingly.

◆ size()

index_type sf::VariableIdList::size ( ) const

overridevirtual

Gets the size of the underlying store.

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

◆ store()

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

overrideprotectedvirtual

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