SimpleEffectSettingsAccess Class Reference

Implementation of EffectSettings for cases where there is only one thread. More...

#include <EffectInterface.h>

Inheritance diagram for SimpleEffectSettingsAccess:

Collaboration diagram for SimpleEffectSettingsAccess:

Public Member Functions
	SimpleEffectSettingsAccess (EffectSettings &settings)
	~SimpleEffectSettingsAccess () override
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
EffectSettings &	mSettings

Detailed Description

Implementation of EffectSettings for cases where there is only one thread.

Definition at line 219 of file EffectInterface.h.

Constructor & Destructor Documentation

SimpleEffectSettingsAccess()

SimpleEffectSettingsAccess::SimpleEffectSettingsAccess ( EffectSettings &  settings )

inlineexplicit

Definition at line 222 of file EffectInterface.h.

      : mSettings{settings} {}

~SimpleEffectSettingsAccess()

SimpleEffectSettingsAccess::~SimpleEffectSettingsAccess ( )

overridedefault

Member Function Documentation

Flush()

void SimpleEffectSettingsAccess::Flush ( )

overridevirtual

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

Precondition

called on the main thread only

Implements EffectSettingsAccess.

Definition at line 40 of file EffectInterface.cpp.

{
}

Get()

const EffectSettings & SimpleEffectSettingsAccess::Get ( )

overridevirtual

Implements EffectSettingsAccess.

Definition at line 25 of file EffectInterface.cpp.

{
   return mSettings;
}

References mSettings.

IsSameAs()

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

overridevirtual

Returns

whether this and the other give access to the same settings

Implements EffectSettingsAccess.

Definition at line 44 of file EffectInterface.cpp.

{
   if (auto pOther =
      dynamic_cast<const SimpleEffectSettingsAccess*>(&other))
      return &this->mSettings == &pOther->mSettings;
   return false;
}

References mSettings.

Set() [1/2]

void SimpleEffectSettingsAccess::Set ( EffectSettings &&  settings, std::unique_ptr< Message >  pMessage  )

overridevirtual

Implements EffectSettingsAccess.

Definition at line 30 of file EffectInterface.cpp.

{
   mSettings = std::move(settings);
}

References mSettings, and settings().

Here is the call graph for this function:

Set() [2/2]

void SimpleEffectSettingsAccess::Set ( std::unique_ptr< Message >  pMessage )

overridevirtual

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

Implements EffectSettingsAccess.

Definition at line 36 of file EffectInterface.cpp.

{
}

Member Data Documentation

mSettings

EffectSettings& SimpleEffectSettingsAccess::mSettings

private

Definition at line 232 of file EffectInterface.h.

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

---

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

• EffectInterface.h
• EffectInterface.cpp