active::setting::Setting Class Reference

Base class for an identified setting for interprocess communication. More...

#include <Setting.h>

Inheritance diagram for active::setting::Setting:

Collaboration diagram for active::setting::Setting:

Public Types
using	Unique = std::unique_ptr<Setting>
	Unique pointer.
using	Shared = std::shared_ptr<Setting>
	Shared pointer.
using	Option = std::optional<Setting>
	Optional.

Public Member Functions
	Setting (utility::NameID::Option identifier=std::nullopt)
	Setting (utility::String::Option name, utility::Guid::Option guid=std::nullopt)
	Setting (const Setting &source)
virtual	~Setting ()=default
virtual Setting *	clonePtr () const =0
virtual bool	operator== (const Setting &ref) const =0
virtual bool	operator< (const Setting &ref) const =0
virtual Setting &	operator= (const Setting &source)=0
virtual bool	empty () const =0
	True if the setting is empty.
virtual utility::String	name () const
	True if the setting is empty.
virtual void	clear ()
virtual void	setDefault ()=0
Public Member Functions inherited from active::utility::Cloner
virtual	~Cloner ()=default

Public Attributes
utility::NameID::Option	identity
	Optional setting identity.

Detailed Description

Base class for an identified setting for interprocess communication.

Constructor & Destructor Documentation

Setting() [1/3]

active::setting::Setting::Setting ( utility::NameID::Option identifier = std::nullopt )

inline

Constructor

Parameters

identifier

An optional identifier for the setting

Setting() [2/3]

active::setting::Setting::Setting ( utility::String::Option name, utility::Guid::Option guid = std::nullopt )

inline

Constructor

Parameters

name	An optional identifying name for the setting
guid	An optional identifying guid for the setting

Here is the call graph for this function:

Setting() [3/3]

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

inline

Copy constructor

Parameters

source

The object to copy

~Setting()

virtual active::setting::Setting::~Setting ( )

virtualdefault

Destructor

Member Function Documentation

clear()

virtual void active::setting::Setting::clear ( )

inlinevirtual

Clear the setting (remove any values)

Reimplemented in active::setting::ValueSetting.

clonePtr()

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

pure virtual

Clone method

Returns

A clone of this object

Implements active::utility::Cloner.

Implemented in active::setting::ValueSetting.

empty()

virtual bool active::setting::Setting::empty ( ) const

pure virtual

True if the setting is empty.

Implemented in active::setting::ValueSetting.

operator<()

virtual bool active::setting::Setting::operator< ( const Setting & ref ) const

pure virtual

Less-than operator

Parameters

ref	The value to compare

Returns

True if this is less than ref

Implemented in active::setting::ValueSetting.

operator=()

virtual Setting & active::setting::Setting::operator= ( const Setting & source )

pure virtual

Assignment operator

Parameters

source

The object to copy

Returns

A reference to this

Implemented in active::setting::ValueSetting.

operator==()

virtual bool active::setting::Setting::operator== ( const Setting & ref ) const

pure virtual

Equality operator

Parameters

ref	The value to compare

Returns

True if the values are identical

Implemented in active::setting::ValueSetting.

setDefault()

virtual void active::setting::Setting::setDefault ( )

pure virtual

Assign a default to the setting

Implemented in active::setting::ValueSetting.

---

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

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