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

#include <Shuttle.h>

Inheritance diagram for ShuttleParams:

[legend]

Collaboration diagram for ShuttleParams:

[legend]

Public Member Functions
	ShuttleParams ()

virtual	~ShuttleParams ()

bool	ShouldSet ()

virtual ShuttleParams &	Optional (bool &WXUNUSED(var))

virtual ShuttleParams &	OptionalY (bool &var)

virtual ShuttleParams &	OptionalN (bool &var)

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

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

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

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

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

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

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

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

Public Attributes
wxString	mParams

bool *	pOptionalFlag

CommandParameters *	mpEap

Detailed Description

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

Definition at line 60 of file Shuttle.h.

Constructor & Destructor Documentation

◆ ShuttleParams()

ShuttleParams::ShuttleParams ( )

inline

Definition at line 66 of file Shuttle.h.

66{ mpEap = NULL; pOptionalFlag = NULL; }

ShuttleParams::mpEap

CommandParameters * mpEap

Definition: Shuttle.h:65

ShuttleParams::pOptionalFlag

bool * pOptionalFlag

Definition: Shuttle.h:64

◆ ~ShuttleParams()

virtual ShuttleParams::~ShuttleParams ( )

inlinevirtual

Definition at line 67 of file Shuttle.h.

67{}

Member Function Documentation

◆ Define() [1/7]

void ShuttleParams::Define	(	bool &	var,
		const wxChar *	key,
		const bool	vdefault,
		const bool	vmin = `false`,
		const bool	vmax = `false`,
		const bool	vscl = `false`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 330 of file Shuttle.cpp.

330{;};

◆ Define() [2/7]

void ShuttleParams::Define	(	double &	var,
		const wxChar *	key,
		const double	vdefault,
		const double	vmin,
		const double	vmax,
		const double	vscl = `1.0f`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 335 of file Shuttle.cpp.

335{;};

◆ Define() [3/7]

void ShuttleParams::Define	(	double &	var,
		const wxChar *	key,
		const float	vdefault,
		const float	vmin,
		const float	vmax,
		const float	vscl = `1.0f`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 334 of file Shuttle.cpp.

334{;};

◆ Define() [4/7]

void ShuttleParams::Define	(	float &	var,
		const wxChar *	key,
		const float	vdefault,
		const float	vmin,
		const float	vmax,
		const float	vscl = `1.0f`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 333 of file Shuttle.cpp.

333{;};

◆ Define() [5/7]

void ShuttleParams::Define	(	int &	var,
		const wxChar *	key,
		const int	vdefault,
		const int	vmin = `0`,
		const int	vmax = `100000`,
		const int	vscl = `1`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 332 of file Shuttle.cpp.

332{;};

◆ Define() [6/7]

void ShuttleParams::Define	(	size_t &	var,
		const wxChar *	key,
		const int	vdefault,
		const int	vmin = `0`,
		const int	vmax = `100000`,
		const int	vscl = `1`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 331 of file Shuttle.cpp.

331{;};

◆ Define() [7/7]

void ShuttleParams::Define	(	wxString &	var,
		const wxChar *	key,
		const wxString	vdefault,
		const wxString	vmin = `{}`,
		const wxString	vmax = `{}`,
		const wxString	vscl = `{}`
	)

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 336 of file Shuttle.cpp.

336{;};

◆ DefineEnum()

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

virtual

Reimplemented in ShuttleGetAutomation, ShuttleSetAutomation, and ShuttleGetDefinition.

Definition at line 337 of file Shuttle.cpp.

337{;};

◆ Optional()

virtual ShuttleParams & ShuttleParams::Optional ( bool & WXUNUSEDvar )

inlinevirtual

Definition at line 69 of file Shuttle.h.

69{ pOptionalFlag = NULL;return *this;};

◆ OptionalN()

virtual ShuttleParams & ShuttleParams::OptionalN ( bool & var )

inlinevirtual

Reimplemented in ShuttleDefaults.

Definition at line 71 of file Shuttle.h.

71{ return Optional( var );};

ShuttleParams::Optional

virtual ShuttleParams & Optional(bool &WXUNUSED(var))

Definition: Shuttle.h:69

◆ OptionalY()

virtual ShuttleParams & ShuttleParams::OptionalY ( bool & var )

inlinevirtual

Reimplemented in ShuttleDefaults.

Definition at line 70 of file Shuttle.h.

70{ return Optional( var );};

◆ ShouldSet()

bool ShuttleParams::ShouldSet ( )

Definition at line 322 of file Shuttle.cpp.

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

References pOptionalFlag.

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

Here is the caller graph for this function:

Member Data Documentation

◆ mParams

wxString ShuttleParams::mParams

Definition at line 63 of file Shuttle.h.

◆ mpEap

CommandParameters* ShuttleParams::mpEap

Definition at line 65 of file Shuttle.h.

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

◆ pOptionalFlag

bool* ShuttleParams::pOptionalFlag

Definition at line 64 of file Shuttle.h.

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

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShuttleParams()

◆ ~ShuttleParams()

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