active::setting::SettingList Class Reference

A list of settings. More...

#include <SettingList.h>

Inheritance diagram for active::setting::SettingList:

Collaboration diagram for active::setting::SettingList:

Public Types
using	base = container::List<Setting>
	Base storage class.
using	iterator = typename base::iterator
	Storage iterator.
using	const_iterator = typename base::const_iterator
	Storage iterator.
using	Shared = std::shared_ptr<SettingList>
	Shared pointer.
using	Option = std::optional<SettingList>
	Optional.
Public Types inherited from active::container::List< Setting >
using	value_t
	Stored type.
using	base
	Base container type.
using	size_type
	Container size (index) type.
using	iterator
	Container iterator type.
using	const_iterator
	Container const iterator type.

Public Member Functions
	SettingList ()
	SettingList (const std::initializer_list< ValueSetting > &settings)
	SettingList (const SettingList &source)
	SettingList (SettingList &&source)
virtual SettingList *	clonePtr () const
virtual SettingList &	operator= (const SettingList &source)
virtual bool	operator== (const SettingList &ref) const
bool	contains (const utility::NameID &nameID) const
SettingList::const_iterator	find (const Setting &setting) const
const_iterator	find (const utility::NameID &nameID) const
ValueSetting *	findValue (const utility::NameID &nameID) const
iterator	find (const utility::NameID &nameID)
SettingList::iterator	find (const Setting &setting)
Public Member Functions inherited from active::container::List< Setting >
	List ()
	List (const std::initializer_list< Derived > &items)
	List (const List &source)
	List (List &&source)
virtual	~List ()=default
auto	operator= (const List &source)
auto	operator= (List &&source)
void	push_back (Setting *item)
void	push_back (Setting &item)
void	emplace_back (Setting &&item)
void	emplace_back (const Setting &item)
void	emplace_back (value_t &&item)
void	emplace_back (value_t &item)
void	push_front (Setting *item)
void	emplace_front (Setting &&item)
void	emplace_front (value_t &&item)
auto	release (iterator &pos)
Public Member Functions inherited from active::utility::Cloner
virtual	~Cloner ()=default

Detailed Description

A list of settings.

Constructor & Destructor Documentation

SettingList() [1/4]

active::setting::SettingList::SettingList ( )

inline

Default constructor

SettingList() [2/4]

SettingList::SettingList

(

const std::initializer_list< ValueSetting > &

settings

)

Constructor

Parameters

settings

Settings to populate into the list (NB: for value types only using an initialiser list)

Here is the call graph for this function:

SettingList() [3/4]

active::setting::SettingList::SettingList ( const SettingList & source )

inline

Copy constructor

Parameters

source

The object to copy

SettingList() [4/4]

active::setting::SettingList::SettingList ( SettingList && source )

inline

Move constructor

Parameters

source

The object to move

Member Function Documentation

clonePtr()

virtual SettingList * active::setting::SettingList::clonePtr ( ) const

inlinevirtual

Clone method

Returns

A clone of this object

Implements active::utility::Cloner.

Reimplemented in active::event::Event, and active::event::Message.

contains()

bool active::setting::SettingList::contains ( const utility::NameID & nameID ) const

inline

Determine if the list contains a setting with a specified ID

Parameters

nameID

The ID to search for

Returns

True if the list contains a matching entry

find() [1/2]

SettingList::iterator SettingList::find

(

const utility::NameID &

nameID

)

Find a setting with a specified ID

Parameters

nameID

The ID to search for

Returns

An iterator pointing to the first matching entry (end on failure)

find() [2/2]

SettingList::const_iterator SettingList::find

(

const utility::NameID &

nameID

)

const

Find a setting with a specified ID

Parameters

nameID

The ID to search for

Returns

An iterator pointing to the first matching entry (end on failure)

findValue()

ValueSetting * SettingList::findValue

(

const utility::NameID &

nameID

)

const

Find a value setting with a specified ID

Parameters

nameID

The ID to search for

Returns

A pointer to the requested value setting (nullptr on failure)

operator=()

SettingList & SettingList::operator= ( const SettingList & source )

virtual

Assignment operator

Parameters

source

The object to copy

Returns

A reference to this

Here is the call graph for this function:

operator==()

bool SettingList::operator== ( const SettingList & ref ) const

virtual

Equality operator

Parameters

ref	The value to compare

Returns

True if the values are identical

---

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

• /Users/rwessel/Documents/Development/ActiveLib/Active/Setting/SettingList.h
• /Users/rwessel/Documents/Development/ActiveLib/Active/Setting/SettingList.cpp