SettingsVisitor that sets parameters to a value (from a string) More...

#include <ShuttleAutomation.h>

Inheritance diagram for ShuttleSetAutomation:

Collaboration diagram for ShuttleSetAutomation:

Public Member Functions
	ShuttleSetAutomation ()

bool	CouldGet (const wxString &key)

void	SetForValidating (CommandParameters *pEap)

void	SetForWriting (CommandParameters *pEap)

SettingsVisitor &	Optional (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
bool	bOK { false }

bool	bWrite { false }

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 a value (from a string)

Definition at line 270 of file ShuttleAutomation.h.

Constructor & Destructor Documentation

◆ ShuttleSetAutomation()

ShuttleSetAutomation::ShuttleSetAutomation ( )

inline

Definition at line 273 of file ShuttleAutomation.h.

273{}

Member Function Documentation

◆ CouldGet()

bool ShuttleSetAutomation::CouldGet ( const wxString & key )

Definition at line 92 of file ShuttleAutomation.cpp.

                                                        {
   // Not optional?  Can get as we will get the default, at worst.
   if( !pOptionalFlag )
      return true;
   bool result = mpEap->HasEntry( key );
   *pOptionalFlag = result;
   pOptionalFlag = NULL;
   return result;
}

References CommandParameters::HasEntry(), key, SettingsVisitorBase< Const >::mpEap, and SettingsVisitorBase< Const >::pOptionalFlag.

Referenced by Define(), and DefineEnum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Define() [1/7]

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

override

Definition at line 102 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   // Use of temp in this and related functions is to handle the case of
   // only committing values if all values pass verification.
   bool temp =var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault);
   if( bWrite && bOK)
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Define() [2/7]

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

override

Definition at line 160 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   double temp = var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault, vmin, vmax);
   if( bWrite && bOK)
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Define() [3/7]

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

override

Definition at line 149 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   double temp = var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault, vmin, vmax);
   if( bWrite && bOK)
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Define() [4/7]

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

override

Definition at line 137 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   float temp = var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault, vmin, vmax);
   if( bWrite && bOK )
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Define() [5/7]

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

override

Definition at line 115 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   int temp =var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault, vmin, vmax);
   if( bWrite && bOK)
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Define() [6/7]

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

override

Definition at line 126 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   int temp = var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault, vmin, vmax);
   if( bWrite && bOK )
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Define() [7/7]

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

override

Definition at line 172 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   wxString temp = var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault);
   if( bWrite && bOK )
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ DefineEnum()

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

override

Definition at line 184 of file ShuttleAutomation.cpp.

{
   CouldGet( key );
   if( !bOK )
      return;
   int temp = var;
   bOK = mpEap->ReadAndVerify(key, &temp, vdefault, strings, nStrings);
   if( bWrite && bOK)
      var = temp;
}

References bOK, bWrite, CouldGet(), key, SettingsVisitorBase< Const >::mpEap, and CommandParameters::ReadAndVerify().

Here is the call graph for this function:

◆ Optional()

SettingsVisitor & ShuttleSetAutomation::Optional ( bool & var )

override

Definition at line 82 of file ShuttleAutomation.cpp.

                                                            {
   pOptionalFlag = &var;
   return *this;
};

References SettingsVisitorBase< Const >::pOptionalFlag.

◆ SetForValidating()

void ShuttleSetAutomation::SetForValidating ( CommandParameters * pEap )

inline

Definition at line 278 of file ShuttleAutomation.h.

                                                    {
      mpEap = pEap;
      bOK = true;
      bWrite = false;
   }

◆ SetForWriting()

void ShuttleSetAutomation::SetForWriting ( CommandParameters * pEap )

inline

Definition at line 283 of file ShuttleAutomation.h.

                                                {
      mpEap = pEap;
      bOK = true;
      bWrite = true;
   }

Member Data Documentation

◆ bOK

bool ShuttleSetAutomation::bOK { false }

Definition at line 274 of file ShuttleAutomation.h.

Referenced by Define(), and DefineEnum().

◆ bWrite

bool ShuttleSetAutomation::bWrite { false }

Definition at line 275 of file ShuttleAutomation.h.

Referenced by Define(), and DefineEnum().

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShuttleSetAutomation()

Member Function Documentation

◆ CouldGet()

◆ Define() [1/7]

◆ Define() [2/7]

◆ Define() [3/7]

◆ Define() [4/7]

◆ Define() [5/7]

◆ Define() [6/7]

◆ Define() [7/7]

◆ DefineEnum()

◆ Optional()

◆ SetForValidating()

◆ SetForWriting()

Member Data Documentation

◆ bOK

◆ bWrite