Generates EffectParameterMethods overrides from variadic template arguments. More...

#include <ShuttleAutomation.h>

Inheritance diagram for CapturedParameters< EffectType, Parameters >:

Collaboration diagram for CapturedParameters< EffectType, Parameters >:

Public Types
using	Params = std::remove_pointer_t< decltype(EffectType::FetchParameters(std::declval< EffectType & >(), std::declval< EffectSettings & >())) >

using	PostSetFunction = std::function< bool(EffectType &, EffectSettings &, Params &, bool) >

Public Member Functions
virtual	~CapturedParameters ()=default

	CapturedParameters ()

template<typename Fn , typename = decltype( std::declval<Fn>()( std::declval<EffectType &>(), std::declval<EffectSettings &>(), std::declval<Params &>(), true) )>
	CapturedParameters (Fn &&PostSet)

void	Reset (Effect &effect) const override

void	Visit (Effect &effect, SettingsVisitor &visitor, EffectSettings &settings) const override

void	Visit (const Effect &effect, ConstSettingsVisitor &visitor, const EffectSettings &settings) const override

void	Get (const Effect &effect, const EffectSettings &settings, CommandParameters &parms) const override

bool	Set (Effect &effect, const CommandParameters &parms, EffectSettings &settings) const override

Public Member Functions inherited from EffectParameterMethods
virtual	~EffectParameterMethods ()

virtual void	Reset (Effect &effect) const =0

virtual void	Visit (Effect &effect, SettingsVisitor &visitor, EffectSettings &settings) const =0

virtual void	Visit (const Effect &effect, ConstSettingsVisitor &visitor, const EffectSettings &settings) const =0

virtual void	Get (const Effect &effect, const EffectSettings &settings, CommandParameters &parms) const =0

virtual bool	Set (Effect &effect, const CommandParameters &parms, EffectSettings &settings) const =0

Static Private Member Functions
template<typename Member , typename Type , typename Value >
static void	ResetOne (Params &structure, const EffectParameter< Params, Member, Type, Value > &param)

static void	DoReset (Effect &effect, EffectSettings settings, Params &structure, const CapturedParameters &This)

template<bool Const, typename Member , typename Type , typename Value >
static void	VisitOne (Params &structure, SettingsVisitorBase< Const > &visitor, const EffectParameter< Params, Member, Type, Value > &param)

template<bool Const, typename Member >
static void	VisitOne (Params &structure, SettingsVisitorBase< Const > &visitor, const EnumParameter< Params, Member > &param)

template<bool Const>
static void	DoVisit (Params &structure, SettingsVisitorBase< Const > &visitor)

template<typename Member , typename Type , typename Value >
static void	GetOne (const Params &structure, CommandParameters &parms, const EffectParameter< Params, Member, Type, Value > &param)

template<typename Member >
static void	GetOne (const Params &structure, CommandParameters &parms, const EnumParameter< Params, Member > &param)

static void	DoGet (const Params &structure, CommandParameters &parms)

template<typename Member , typename Type , typename Value >
static bool	SetOne (Params &structure, const CommandParameters &parms, const EffectParameter< Params, Member, Type, Value > &param)

template<typename Member >
static bool	SetOne (Params &structure, const CommandParameters &parms, const EnumParameter< Params, Member > &param)

static bool	DoSet (Effect &effect, EffectSettings &settings, Params &structure, const CapturedParameters &This, const CommandParameters &parms)

Private Attributes
PostSetFunction	PostSetFn

Detailed Description

template<typename EffectType, const auto &... Parameters>
class CapturedParameters< EffectType, Parameters >

Generates EffectParameterMethods overrides from variadic template arguments.

For each effect parameter, the function... Reset resets it to a default Visit visits it with a SettingsVisitor object; there are overloads taking SettingsVisitor and ConstSettingsVisitor Get serializes it to a string Set deserializes it from a string and returns a success flag (if there is failure, parameters might not all be unchanged)

The constructor optionally takes an argument which is a function to be called at the end of Reset or Set, and returning a value for Set.

Template Parameters

EffectType	subclass of Effect, expected to define a public static member function FetchParameters, taking EffectType & and EffectSettings &, and returning a pointer to something that holds the parameters
Parameters	a pack of non-type template parameters, whose types are specializations of the class template EffectParameter

TODO in C++20: could use simply auto ...Parameters if they are constexpr

Definition at line 60 of file ShuttleAutomation.h.

Member Typedef Documentation

◆ Params

template<typename EffectType , const auto &... Parameters>

using CapturedParameters< EffectType, Parameters >::Params = std::remove_pointer_t< decltype( EffectType::FetchParameters( std::declval<EffectType&>(), std::declval<EffectSettings &>()) ) >

Definition at line 62 of file ShuttleAutomation.h.

◆ PostSetFunction

template<typename EffectType , const auto &... Parameters>

using CapturedParameters< EffectType, Parameters >::PostSetFunction = std::function< bool(EffectType&, EffectSettings &, Params &, bool) >

Definition at line 74 of file ShuttleAutomation.h.

Constructor & Destructor Documentation

◆ ~CapturedParameters()

template<typename EffectType , const auto &... Parameters>

virtual CapturedParameters< EffectType, Parameters >::~CapturedParameters ( )

virtualdefault

◆ CapturedParameters() [1/2]

template<typename EffectType , const auto &... Parameters>

CapturedParameters< EffectType, Parameters >::CapturedParameters ( )

inline

Definition at line 79 of file ShuttleAutomation.h.

79{}

◆ CapturedParameters() [2/2]

template<typename EffectType , const auto &... Parameters>

template<typename Fn , typename = decltype( std::declval<Fn>()( std::declval<EffectType &>(), std::declval<EffectSettings &>(), std::declval<Params &>(), true) )>

CapturedParameters< EffectType, Parameters >::CapturedParameters ( Fn && PostSet )

inlineexplicit

Definition at line 90 of file ShuttleAutomation.h.

91 : PostSetFn{ std::forward<Fn>(PostSet) }

92 {}

CapturedParameters::PostSetFn

PostSetFunction PostSetFn

Definition: ShuttleAutomation.h:140

Member Function Documentation

◆ DoGet()

template<typename EffectType , const auto &... Parameters>

static void CapturedParameters< EffectType, Parameters >::DoGet	(	const Params &	structure,
		CommandParameters &	parms
	)

inlinestaticprivate

Definition at line 199 of file ShuttleAutomation.h.

                                                                        {
      (GetOne(structure, parms, Parameters), ...);
   }

References CapturedParameters< EffectType, Parameters >::GetOne().

Referenced by CapturedParameters< EffectType, Parameters >::Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoReset()

template<typename EffectType , const auto &... Parameters>

static void CapturedParameters< EffectType, Parameters >::DoReset	(	Effect &	effect,
		EffectSettings	settings,
		Params &	structure,
		const CapturedParameters< EffectType, Parameters > &	This
	)

inlinestaticprivate

Definition at line 152 of file ShuttleAutomation.h.

                                      {
      (ResetOne(structure, Parameters), ...);
      // Call the post-set function after all other assignments
      if (This.PostSetFn)
         This.PostSetFn(
            static_cast<EffectType&>(effect), settings, structure, false);
   }

References CapturedParameters< EffectType, Parameters >::PostSetFn, CapturedParameters< EffectType, Parameters >::ResetOne(), and settings().

Referenced by CapturedParameters< EffectType, Parameters >::Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoSet()

template<typename EffectType , const auto &... Parameters>

static bool CapturedParameters< EffectType, Parameters >::DoSet	(	Effect &	effect,
		EffectSettings &	settings,
		Params &	structure,
		const CapturedParameters< EffectType, Parameters > &	This,
		const CommandParameters &	parms
	)

inlinestaticprivate

Definition at line 228 of file ShuttleAutomation.h.

                                                                      {
      if (!(SetOne(structure, parms, Parameters) && ...))
         return false;
      // Call the post-set function after all other assignments, or return
      // true if no function was given
      return !This.PostSetFn ||
         This.PostSetFn(
            static_cast<EffectType&>(effect), settings, structure, true);
   }

References CapturedParameters< EffectType, Parameters >::PostSetFn, CapturedParameters< EffectType, Parameters >::SetOne(), and settings().

Referenced by CapturedParameters< EffectType, Parameters >::Set().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoVisit()

template<typename EffectType , const auto &... Parameters>

template<bool Const>

static void CapturedParameters< EffectType, Parameters >::DoVisit	(	Params &	structure,
		SettingsVisitorBase< Const > &	visitor
	)

inlinestaticprivate

Definition at line 181 of file ShuttleAutomation.h.

                                                                               {
      (VisitOne<Const>(structure, visitor, Parameters), ...);
   }

Referenced by CapturedParameters< EffectType, Parameters >::Visit().

Here is the caller graph for this function:

◆ Get()

template<typename EffectType , const auto &... Parameters>

void CapturedParameters< EffectType, Parameters >::Get	(	const Effect &	effect,
		const EffectSettings &	settings,
		CommandParameters &	parms
	)		const

inlineoverridevirtual

Implements EffectParameterMethods.

Definition at line 119 of file ShuttleAutomation.h.

                                                {
      // const_cast the effect...
      auto &nonconstEffect = const_cast<Effect &>(effect);
      // ... and the settings ...
      auto &nonconstSettings = const_cast<EffectSettings&>(settings);
      // ... but only to fetch the structure and pass it as const &
      if (auto pStruct = EffectType::FetchParameters(
         static_cast<EffectType&>(nonconstEffect), nonconstSettings))
         DoGet(*pStruct, parms);
   }

References CapturedParameters< EffectType, Parameters >::DoGet(), and settings().

Here is the call graph for this function:

◆ GetOne() [1/2]

template<typename EffectType , const auto &... Parameters>

template<typename Member , typename Type , typename Value >

static void CapturedParameters< EffectType, Parameters >::GetOne	(	const Params &	structure,
		CommandParameters &	parms,
		const EffectParameter< Params, Member, Type, Value > &	param
	)

inlinestaticprivate

Definition at line 186 of file ShuttleAutomation.h.

                                                                   {
      // Serialize one variable
      parms.Write( param.key, static_cast<Value>(structure.*(param.mem)) );
   }

References EffectParameter< Structure, Member, Type, Value >::key, and EffectParameter< Structure, Member, Type, Value >::mem.

Referenced by CapturedParameters< EffectType, Parameters >::DoGet().

Here is the caller graph for this function:

◆ GetOne() [2/2]

template<typename EffectType , const auto &... Parameters>

template<typename Member >

static void CapturedParameters< EffectType, Parameters >::GetOne	(	const Params &	structure,
		CommandParameters &	parms,
		const EnumParameter< Params, Member > &	param
	)

inlinestaticprivate

Definition at line 193 of file ShuttleAutomation.h.

                                                  {
      // Serialize one enumeration variable as a string identifier, not a number
      parms.Write(
         param.key, param.symbols[ structure.*(param.mem) ].Internal() );
   }

References ComponentInterfaceSymbol::Internal(), EffectParameter< Structure, Member, Type, Value >::key, EffectParameter< Structure, Member, Type, Value >::mem, and EnumParameter< Structure, Member >::symbols.

Here is the call graph for this function:

◆ Reset()

template<typename EffectType , const auto &... Parameters>

void CapturedParameters< EffectType, Parameters >::Reset ( Effect & effect ) const

inlineoverridevirtual

Implements EffectParameterMethods.

Definition at line 94 of file ShuttleAutomation.h.

                                             {
      EffectSettings dummy;
      if (auto pStruct = EffectType::FetchParameters(
         static_cast<EffectType&>(effect), dummy))
         DoReset(effect, dummy, *pStruct, *this);
   }

References CapturedParameters< EffectType, Parameters >::DoReset().

Here is the call graph for this function:

◆ ResetOne()

template<typename EffectType , const auto &... Parameters>

template<typename Member , typename Type , typename Value >

static void CapturedParameters< EffectType, Parameters >::ResetOne	(	Params &	structure,
		const EffectParameter< Params, Member, Type, Value > &	param
	)

inlinestaticprivate

Definition at line 147 of file ShuttleAutomation.h.

                                                                   {
      // Do one assignment of the default value
      structure.*(param.mem) = param.def;
   }

References EffectParameter< Structure, Member, Type, Value >::def, and EffectParameter< Structure, Member, Type, Value >::mem.

Referenced by CapturedParameters< EffectType, Parameters >::DoReset().

Here is the caller graph for this function:

◆ Set()

template<typename EffectType , const auto &... Parameters>

bool CapturedParameters< EffectType, Parameters >::Set	(	Effect &	effect,
		const CommandParameters &	parms,
		EffectSettings &	settings
	)		const

inlineoverridevirtual

Implements EffectParameterMethods.

Definition at line 130 of file ShuttleAutomation.h.

                                               {
      if (auto pStruct = EffectType::FetchParameters(
         static_cast<EffectType&>(effect), settings))
         return DoSet(effect, settings, *pStruct, *this, parms);
      else
         return false;
   }

References CapturedParameters< EffectType, Parameters >::DoSet(), and settings().

Here is the call graph for this function:

◆ SetOne() [1/2]

template<typename EffectType , const auto &... Parameters>

template<typename Member , typename Type , typename Value >

static bool CapturedParameters< EffectType, Parameters >::SetOne	(	Params &	structure,
		const CommandParameters &	parms,
		const EffectParameter< Params, Member, Type, Value > &	param
	)

inlinestaticprivate

Definition at line 204 of file ShuttleAutomation.h.

                                                                   {
      // Deserialize and assign one variable (or fail)
      Value temp;
      if (!parms.ReadAndVerify(param.key, &temp, param.def,
         param.min, param.max))
         return false;
      structure.*(param.mem) = temp;
      return true;
   }

References EffectParameter< Structure, Member, Type, Value >::def, EffectParameter< Structure, Member, Type, Value >::key, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::mem, EffectParameter< Structure, Member, Type, Value >::min, and CommandParameters::ReadAndVerify().

Referenced by CapturedParameters< EffectType, Parameters >::DoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOne() [2/2]

template<typename EffectType , const auto &... Parameters>

template<typename Member >

static bool CapturedParameters< EffectType, Parameters >::SetOne	(	Params &	structure,
		const CommandParameters &	parms,
		const EnumParameter< Params, Member > &	param
	)

inlinestaticprivate

Definition at line 217 of file ShuttleAutomation.h.

                                                  {
      // Deserialize and assign one enumeration variable (or fail)
      int temp;
      if (!parms.ReadAndVerify(param.key, &temp, param.def,
         param.symbols, param.nSymbols))
         return false;
      structure.*(param.mem) = temp;
      return true;
   }

References EffectParameter< Structure, Member, Type, Value >::def, EffectParameter< Structure, Member, Type, Value >::key, EffectParameter< Structure, Member, Type, Value >::mem, EnumParameter< Structure, Member >::nSymbols, CommandParameters::ReadAndVerify(), and EnumParameter< Structure, Member >::symbols.

Here is the call graph for this function:

◆ Visit() [1/2]

template<typename EffectType , const auto &... Parameters>

void CapturedParameters< EffectType, Parameters >::Visit	(	const Effect &	effect,
		ConstSettingsVisitor &	visitor,
		const EffectSettings &	settings
	)		const

inlineoverridevirtual

Implements EffectParameterMethods.

Definition at line 107 of file ShuttleAutomation.h.

                     {
      // const_cast the effect...
      auto &nonconstEffect = const_cast<Effect&>(effect);
      // ... and the settings ...
      auto &nonconstSettings = const_cast<EffectSettings&>(settings);
      // ... but only to fetch the structure and pass it as const &
      if (auto pStruct = EffectType::FetchParameters(
         static_cast<EffectType&>(nonconstEffect), nonconstSettings))
         DoVisit(*pStruct, visitor);
   }

References CapturedParameters< EffectType, Parameters >::DoVisit(), and settings().

Here is the call graph for this function:

◆ Visit() [2/2]

template<typename EffectType , const auto &... Parameters>

void CapturedParameters< EffectType, Parameters >::Visit	(	Effect &	effect,
		SettingsVisitor &	visitor,
		EffectSettings &	settings
	)		const

inlineoverridevirtual

Implements EffectParameterMethods.

Definition at line 100 of file ShuttleAutomation.h.

                     {
      if (auto pStruct = EffectType::FetchParameters(
         static_cast<EffectType&>(effect), settings))
         DoVisit<false>(*pStruct, visitor);
   }

References settings().

Here is the call graph for this function:

◆ VisitOne() [1/2]

template<typename EffectType , const auto &... Parameters>

template<bool Const, typename Member , typename Type , typename Value >

static void CapturedParameters< EffectType, Parameters >::VisitOne	(	Params &	structure,
		SettingsVisitorBase< Const > &	visitor,
		const EffectParameter< Params, Member, Type, Value > &	param
	)

inlinestaticprivate

Definition at line 163 of file ShuttleAutomation.h.

                                                                   {
      // Visit one variable
      visitor.Define( structure.*(param.mem), param.key,
         static_cast<Member>(param.def),
         static_cast<Member>(param.min),
         static_cast<Member>(param.max),
         static_cast<Member>(param.scale) );
   }

References EffectParameter< Structure, Member, Type, Value >::def, SettingsVisitorBase< Const >::Define(), EffectParameter< Structure, Member, Type, Value >::key, EffectParameter< Structure, Member, Type, Value >::max, EffectParameter< Structure, Member, Type, Value >::mem, EffectParameter< Structure, Member, Type, Value >::min, and EffectParameter< Structure, Member, Type, Value >::scale.

Here is the call graph for this function:

◆ VisitOne() [2/2]

template<typename EffectType , const auto &... Parameters>

template<bool Const, typename Member >

static void CapturedParameters< EffectType, Parameters >::VisitOne	(	Params &	structure,
		SettingsVisitorBase< Const > &	visitor,
		const EnumParameter< Params, Member > &	param
	)

inlinestaticprivate

Definition at line 174 of file ShuttleAutomation.h.

                                                  {
      // Visit one enumeration variable, passing the table of names
      visitor.DefineEnum( structure.*(param.mem),
         param.key, param.def, param.symbols, param.nSymbols );
   }

References EffectParameter< Structure, Member, Type, Value >::def, SettingsVisitorBase< Const >::DefineEnum(), EffectParameter< Structure, Member, Type, Value >::key, EffectParameter< Structure, Member, Type, Value >::mem, EnumParameter< Structure, Member >::nSymbols, and EnumParameter< Structure, Member >::symbols.

Here is the call graph for this function:

Member Data Documentation

◆ PostSetFn

template<typename EffectType , const auto &... Parameters>

PostSetFunction CapturedParameters< EffectType, Parameters >::PostSetFn

private

Definition at line 140 of file ShuttleAutomation.h.

Referenced by CapturedParameters< EffectType, Parameters >::DoReset(), and CapturedParameters< EffectType, Parameters >::DoSet().

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

ShuttleAutomation.h

Public Types

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Params

◆ PostSetFunction

Constructor & Destructor Documentation

◆ ~CapturedParameters()

◆ CapturedParameters() [1/2]

◆ CapturedParameters() [2/2]

Member Function Documentation

◆ DoGet()

◆ DoReset()

◆ DoSet()

◆ DoVisit()

◆ Get()

◆ GetOne() [1/2]

◆ GetOne() [2/2]

◆ Reset()

◆ ResetOne()

◆ Set()

◆ SetOne() [1/2]

◆ SetOne() [2/2]

◆ Visit() [1/2]

◆ Visit() [2/2]

◆ VisitOne() [1/2]

◆ VisitOne() [2/2]

Member Data Documentation

◆ PostSetFn