Visitor of effect or command parameters. This is a base class with lots of virtual functions that do nothing by default. Unrelated to class Shuttle. More...

#include <SettingsVisitor.h>

Inheritance diagram for SettingsVisitorBase< Const >:

[legend]

Collaboration diagram for SettingsVisitorBase< Const >:

[legend]

Public Types
template<typename T >
using	Ref = std::conditional_t< Const, const T &, T & >

template<typename T >
using	Arg = std::conditional_t< Const, T, T & >

Public Member Functions
	SettingsVisitorBase ()

virtual	~SettingsVisitorBase ()

bool	ShouldSet ()

virtual SettingsVisitorBase &	Optional (Ref< bool > var)

virtual SettingsVisitorBase &	OptionalY (Ref< bool > var)

virtual SettingsVisitorBase &	OptionalN (Ref< bool > var)

virtual void	Define (Arg< bool > var, const wxChar *key, bool vdefault, bool vmin=false, bool vmax=false, bool vscl=false)

virtual void	Define (Arg< size_t > var, const wxChar *key, int vdefault, int vmin=0, int vmax=100000, int vscl=1)

virtual void	Define (Arg< int > var, const wxChar *key, int vdefault, int vmin=0, int vmax=100000, int vscl=1)

virtual void	Define (Arg< float > var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl=1.0f)

virtual void	Define (Arg< double > var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl=1.0f)

virtual void	Define (Arg< double > var, const wxChar *key, double vdefault, double vmin, double vmax, double vscl=1.0f)

virtual void	Define (Ref< wxString > var, const wxChar *key, wxString vdefault, wxString vmin={}, wxString vmax={}, wxString vscl={})

virtual void	DefineEnum (Arg< int > var, const wxChar *key, int vdefault, const EnumValueSymbol strings[], size_t nStrings)

Public Attributes
wxString	mParams

std::conditional_t< Const, const bool, bool > *	pOptionalFlag {}

CommandParameters *	mpEap {}

Detailed Description

template<bool Const>
class SettingsVisitorBase< Const >

Visitor of effect or command parameters. This is a base class with lots of virtual functions that do nothing by default. Unrelated to class Shuttle.

Template Parameters

Const if true, then visited settings are not modifiable.

Definition at line 78 of file SettingsVisitor.h.

Member Typedef Documentation

◆ Arg

template<bool Const>

template<typename T >

using SettingsVisitorBase< Const >::Arg = std::conditional_t<Const, T, T&>

Definition at line 84 of file SettingsVisitor.h.

◆ Ref

template<bool Const>

template<typename T >

using SettingsVisitorBase< Const >::Ref = std::conditional_t<Const, const T&, T&>

Definition at line 82 of file SettingsVisitor.h.

Constructor & Destructor Documentation

◆ SettingsVisitorBase()

template<bool Const>

SettingsVisitorBase< Const >::SettingsVisitorBase ( )

inline

Definition at line 90 of file SettingsVisitor.h.

90{}

◆ ~SettingsVisitorBase()

template<bool Const>

SettingsVisitorBase< Const >::~SettingsVisitorBase ( )

virtualdefault

Member Function Documentation

◆ Define() [1/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Arg< bool >	var,
		const wxChar *	key,
		bool	vdefault,
		bool	vmin = `false`,
		bool	vmax = `false`,
		bool	vscl = `false`
	)

virtual

Definition at line 65 of file SettingsVisitor.cpp.

67{}

Referenced by CapturedParameters< EffectType, Parameters >::VisitOne(), EffectEqualization::VisitSettings(), and NyquistEffect::VisitSettings().

Here is the caller graph for this function:

◆ Define() [2/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Arg< double >	var,
		const wxChar *	key,
		double	vdefault,
		double	vmin,
		double	vmax,
		double	vscl = `1.0f`
	)

virtual

Definition at line 90 of file SettingsVisitor.cpp.

92{}

◆ Define() [3/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Arg< double >	var,
		const wxChar *	key,
		float	vdefault,
		float	vmin,
		float	vmax,
		float	vscl = `1.0f`
	)

virtual

Definition at line 85 of file SettingsVisitor.cpp.

87{}

◆ Define() [4/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Arg< float >	var,
		const wxChar *	key,
		float	vdefault,
		float	vmin,
		float	vmax,
		float	vscl = `1.0f`
	)

virtual

Definition at line 80 of file SettingsVisitor.cpp.

82{}

◆ Define() [5/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Arg< int >	var,
		const wxChar *	key,
		int	vdefault,
		int	vmin = `0`,
		int	vmax = `100000`,
		int	vscl = `1`
	)

virtual

Definition at line 75 of file SettingsVisitor.cpp.

77{}

◆ Define() [6/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Arg< size_t >	var,
		const wxChar *	key,
		int	vdefault,
		int	vmin = `0`,
		int	vmax = `100000`,
		int	vscl = `1`
	)

virtual

Definition at line 70 of file SettingsVisitor.cpp.

72{}

◆ Define() [7/7]

template<bool Const>

void SettingsVisitorBase< Const >::Define	(	Ref< wxString >	var,
		const wxChar *	key,
		wxString	vdefault,
		wxString	vmin = `{}`,
		wxString	vmax = `{}`,
		wxString	vscl = `{}`
	)

virtual

Definition at line 95 of file SettingsVisitor.cpp.

97{}

◆ DefineEnum()

template<bool Const>

void SettingsVisitorBase< Const >::DefineEnum	(	Arg< int >	var,
		const wxChar *	key,
		int	vdefault,
		const EnumValueSymbol	strings[],
		size_t	nStrings
	)

virtual

Definition at line 100 of file SettingsVisitor.cpp.

102{}

Referenced by CapturedParameters< EffectType, Parameters >::VisitOne(), and NyquistEffect::VisitSettings().

Here is the caller graph for this function:

◆ Optional()

template<bool Const>

auto SettingsVisitorBase< Const >::Optional ( Ref< bool > var )

virtual

Definition at line 28 of file SettingsVisitor.cpp.

{
   pOptionalFlag = nullptr;
   return *this;
}

◆ OptionalN()

template<bool Const>

auto SettingsVisitorBase< Const >::OptionalN ( Ref< bool > var )

virtual

Definition at line 43 of file SettingsVisitor.cpp.

{
   return Optional( var );
}

◆ OptionalY()

template<bool Const>

auto SettingsVisitorBase< Const >::OptionalY ( Ref< bool > var )

virtual

Definition at line 36 of file SettingsVisitor.cpp.

{
   return Optional( var );
}

◆ ShouldSet()

template<bool Const>

bool SettingsVisitorBase< Const >::ShouldSet

Definition at line 54 of file SettingsVisitor.cpp.

{
   if( !pOptionalFlag )
      return true;
   bool result = *pOptionalFlag;
   pOptionalFlag = NULL;
   return result;
}

Referenced by ShuttleGetAutomation::Define(), and ShuttleGetAutomation::DefineEnum().

Here is the caller graph for this function:

Member Data Documentation

◆ mParams

template<bool Const>

wxString SettingsVisitorBase< Const >::mParams

Definition at line 86 of file SettingsVisitor.h.

◆ mpEap

template<bool Const>

CommandParameters* SettingsVisitorBase< Const >::mpEap {}

Definition at line 88 of file SettingsVisitor.h.

Referenced by ShuttleSetAutomation::CouldGet(), ShuttleSetAutomation::Define(), ShuttleGetAutomation::Define(), ShuttleSetAutomation::DefineEnum(), and ShuttleGetAutomation::DefineEnum().

◆ pOptionalFlag

template<bool Const>

std::conditional_t<Const, const bool, bool>* SettingsVisitorBase< Const >::pOptionalFlag {}

Definition at line 87 of file SettingsVisitor.h.

Referenced by ShuttleSetAutomation::CouldGet(), ShuttleGetDefinition::IsOptional(), ShuttleSetAutomation::Optional(), ShuttleDefaults::Optional(), ShuttleGetAutomation::Optional(), ShuttleGetDefinition::Optional(), ShuttleDefaults::OptionalN(), and ShuttleDefaults::OptionalY().

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

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ Arg

◆ Ref

Constructor & Destructor Documentation

◆ SettingsVisitorBase()

◆ ~SettingsVisitorBase()

Member Function Documentation

◆ Define() [1/7]

◆ Define() [2/7]

◆ Define() [3/7]

◆ Define() [4/7]

◆ Define() [5/7]

◆ Define() [6/7]

◆ Define() [7/7]

◆ DefineEnum()

◆ Optional()

◆ OptionalN()

◆ OptionalY()

◆ ShouldSet()

Member Data Documentation

◆ mParams

◆ mpEap

◆ pOptionalFlag