anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee Class Reference

Inheritance diagram for anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee:

Collaboration diagram for anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee:

Public Member Functions
	EffectSettingsAccessTee (EffectSettingsAccess &main, const std::shared_ptr< EffectSettingsAccess > &pSide={})
const EffectSettings &	Get () override
void	Set (EffectSettings &&settings, std::unique_ptr< Message > pMessage) override
void	Set (std::unique_ptr< Message > pMessage) override
	Message-only overload of Set(). In future, this should be the only one. More...
void	Flush () override
	Make the last Set changes "persistent" in underlying storage. More...
bool	IsSameAs (const EffectSettingsAccess &other) const override
Public Member Functions inherited from EffectSettingsAccess
virtual	~EffectSettingsAccess ()
virtual const EffectSettings &	Get ()=0
virtual void	Set (EffectSettings &&settings, std::unique_ptr< Message > pMessage=nullptr)=0
virtual void	Set (std::unique_ptr< Message > pMessage=nullptr)=0
	Message-only overload of Set(). In future, this should be the only one. More...
virtual void	Flush ()=0
	Make the last Set changes "persistent" in underlying storage. More...
virtual bool	IsSameAs (const EffectSettingsAccess &other) const =0
template<typename Function >
void	ModifySettings (Function &&function)
	Do a correct read-modify-write of settings. More...

Private Attributes
const std::shared_ptr< EffectSettingsAccess >	mpMain
const std::weak_ptr< EffectSettingsAccess >	mwSide

Detailed Description

Decorate an EffectSettingsAccess with a Set that replicates changes into a second EffectSettingsAccess, while that one still exists

Name inspired by man 1 tee

Definition at line 167 of file EffectUI.cpp.

Constructor & Destructor Documentation

EffectSettingsAccessTee()

EffectSettingsAccessTee::EffectSettingsAccessTee	(	EffectSettingsAccess &	main,
		const std::shared_ptr< EffectSettingsAccess > &	pSide = {}
	)

Definition at line 184 of file EffectUI.cpp.

   : mpMain{ main.shared_from_this() } 
   , mwSide{ pSide } 
{
}

Member Function Documentation

Flush()

void EffectSettingsAccessTee::Flush ( )

overridevirtual

Make the last Set changes "persistent" in underlying storage.

Precondition

called on the main thread only

Implements EffectSettingsAccess.

Definition at line 216 of file EffectUI.cpp.

{
   mpMain->Flush();
   if (auto pSide = mwSide.lock())
      pSide->Flush();
}

References mpMain, and mwSide.

Get()

const EffectSettings & EffectSettingsAccessTee::Get ( )

overridevirtual

Implements EffectSettingsAccess.

Definition at line 192 of file EffectUI.cpp.

                                                   {
   return mpMain->Get();
}

References mpMain.

IsSameAs()

bool EffectSettingsAccessTee::IsSameAs ( const EffectSettingsAccess &  other ) const

overridevirtual

Returns

whether this and the other give access to the same settings

Implements EffectSettingsAccess.

Definition at line 223 of file EffectUI.cpp.

{
   return mpMain->IsSameAs(other);
}

References mpMain.

Set() [1/2]

void anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee::Set ( EffectSettings &&  settings, std::unique_ptr< Message >  pMessage  )

overridevirtual

Implements EffectSettingsAccess.

Set() [2/2]

void anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee::Set ( std::unique_ptr< Message >  pMessage )

overridevirtual

Message-only overload of Set(). In future, this should be the only one.

Implements EffectSettingsAccess.

Member Data Documentation

mpMain

const std::shared_ptr<EffectSettingsAccess> anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee::mpMain

private

Invariant

not null

Definition at line 179 of file EffectUI.cpp.

Referenced by Flush(), Get(), and IsSameAs().

mwSide

const std::weak_ptr<EffectSettingsAccess> anonymous_namespace{EffectUI.cpp}::EffectSettingsAccessTee::mwSide

private

Definition at line 180 of file EffectUI.cpp.

Referenced by Flush().

---

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

• EffectUI.cpp