ShuttleDefaults Class Reference

SettingsVisitor that sets parameters to their default values. More...

#include <ShuttleAutomation.h>

Inheritance diagram for ShuttleDefaults:

Collaboration diagram for ShuttleDefaults:

Public Member Functions
SettingsVisitor &	Optional (bool &var) override
SettingsVisitor &	OptionalY (bool &var) override
SettingsVisitor &	OptionalN (bool &var) override
void	Define (bool &var, const wxChar *key, bool vdefault, bool vmin, bool vmax, bool vscl) override
void	Define (int &var, const wxChar *key, int vdefault, int vmin, int vmax, int vscl) override
void	Define (size_t &var, const wxChar *key, int vdefault, int vmin, int vmax, int vscl) override
void	Define (float &var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl) override
void	Define (double &var, const wxChar *key, float vdefault, float vmin, float vmax, float vscl) override
void	Define (double &var, const wxChar *key, double vdefault, double vmin, double vmax, double vscl) override
void	Define (wxString &var, const wxChar *key, wxString vdefault, wxString vmin, wxString vmax, wxString vscl) override
void	DefineEnum (int &var, const wxChar *key, int vdefault, const EnumValueSymbol strings[], size_t nStrings) override
Public Member Functions inherited from SettingsVisitorBase< Const >
	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	Result
Public Attributes inherited from SettingsVisitorBase< Const >
wxString	mParams
std::conditional_t< Const, const bool, bool > *	pOptionalFlag {}
CommandParameters *	mpEap {}

Additional Inherited Members
Public Types inherited from SettingsVisitorBase< Const >
template<typename T >
using	Ref = std::conditional_t< Const, const T &, T & >
template<typename T >
using	Arg = std::conditional_t< Const, T, T & >

Detailed Description

SettingsVisitor that sets parameters to their default values.

Definition at line 311 of file ShuttleAutomation.h.

Member Function Documentation

Define() [1/7]

void ShuttleDefaults::Define ( bool &  var, const wxChar *  key, bool  vdefault, bool  vmin, bool  vmax, bool  vscl  )

override

Definition at line 216 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Define() [2/7]

void ShuttleDefaults::Define ( double &  var, const wxChar *  key, double  vdefault, double  vmin, double  vmax, double  vscl  )

override

Definition at line 246 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Define() [3/7]

void ShuttleDefaults::Define ( double &  var, const wxChar *  key, float  vdefault, float  vmin, float  vmax, float  vscl  )

override

Definition at line 240 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Define() [4/7]

void ShuttleDefaults::Define ( float &  var, const wxChar *  key, float  vdefault, float  vmin, float  vmax, float  vscl  )

override

Definition at line 234 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Define() [5/7]

void ShuttleDefaults::Define ( int &  var, const wxChar *  key, int  vdefault, int  vmin, int  vmax, int  vscl  )

override

Definition at line 222 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Define() [6/7]

void ShuttleDefaults::Define ( size_t &  var, const wxChar *  key, int  vdefault, int  vmin, int  vmax, int  vscl  )

override

Definition at line 228 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Define() [7/7]

void ShuttleDefaults::Define ( wxString &  var, const wxChar *  key, wxString  vdefault, wxString  vmin, wxString  vmax, wxString  vscl  )

override

Definition at line 252 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

DefineEnum()

void ShuttleDefaults::DefineEnum ( int &  var, const wxChar *  key, int  vdefault, const EnumValueSymbol  strings[], size_t  nStrings  )

override

Definition at line 258 of file ShuttleAutomation.cpp.

{
   var = vdefault;
}

Optional()

SettingsVisitor & ShuttleDefaults::Optional ( bool &  var )

override

Definition at line 195 of file ShuttleAutomation.cpp.

{
   var = true;
   pOptionalFlag = nullptr;
   return *this;
}

References SettingsVisitorBase< Const >::pOptionalFlag.

OptionalN()

SettingsVisitor & ShuttleDefaults::OptionalN ( bool &  var )

override

Definition at line 209 of file ShuttleAutomation.cpp.

{
   var = false;
   pOptionalFlag = nullptr;
   return *this;
}

References SettingsVisitorBase< Const >::pOptionalFlag.

OptionalY()

SettingsVisitor & ShuttleDefaults::OptionalY ( bool &  var )

override

Definition at line 202 of file ShuttleAutomation.cpp.

{
   var = true;
   pOptionalFlag = nullptr;
   return *this;
}

References SettingsVisitorBase< Const >::pOptionalFlag.

Member Data Documentation

Result

wxString ShuttleDefaults::Result

Definition at line 314 of file ShuttleAutomation.h.

---

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

• ShuttleAutomation.h
• ShuttleAutomation.cpp