SettingsVisitor that retrieves a JSON format definition of a command's parameters. More...

#include <ShuttleGetDefinition.h>

Inheritance diagram for ShuttleGetDefinition:

Collaboration diagram for ShuttleGetDefinition:

Public Member Functions
	ShuttleGetDefinition (CommandMessageTarget &target)

bool	IsOptional ()

ConstSettingsVisitor &	Optional (const 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 (const 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 Member Functions inherited from CommandMessageTargetDecorator
	CommandMessageTargetDecorator (CommandMessageTarget &target)

	~CommandMessageTargetDecorator () override

void	Update (const wxString &message) override

void	StartArray () override

void	EndArray () override

void	StartStruct () override

void	EndStruct () override

void	AddItem (const wxString &value, const wxString &name={}) override

void	AddBool (const bool value, const wxString &name={}) override

void	AddItem (const double value, const wxString &name={}) override

void	StartField (const wxString &name={}) override

void	EndField () override

void	Flush () override

Public Member Functions inherited from CommandMessageTarget
	CommandMessageTarget ()

virtual	~CommandMessageTarget ()

virtual void	Update (const wxString &message)=0

virtual void	StartArray ()

virtual void	EndArray ()

virtual void	StartStruct ()

virtual void	EndStruct ()

virtual void	AddItem (const wxString &value, const wxString &name={})

virtual void	AddBool (const bool value, const wxString &name={})

virtual void	AddItem (const double value, const wxString &name={})

virtual void	StartField (const wxString &name={})

virtual void	EndField ()

virtual void	Flush ()

wxString	Escaped (const wxString &str)

Public Attributes
wxString	Result

Public Attributes inherited from SettingsVisitorBase< Const >
wxString	mParams

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

CommandParameters *	mpEap {}

Public Attributes inherited from CommandMessageTargetDecorator
CommandMessageTarget &	mTarget

Public Attributes inherited from CommandMessageTarget
std::vector< int >	mCounts

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 retrieves a JSON format definition of a command's parameters.

Definition at line 20 of file ShuttleGetDefinition.h.

Constructor & Destructor Documentation

◆ ShuttleGetDefinition()

ShuttleGetDefinition::ShuttleGetDefinition ( CommandMessageTarget & target )

Definition at line 26 of file ShuttleGetDefinition.cpp.

                                                                        : CommandMessageTargetDecorator{ target }
{
}

Member Function Documentation

◆ Define() [1/7]

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

override

Definition at line 31 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "bool", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( vdefault ? "True" : "False", "default" );
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ Define() [2/7]

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

override

Definition at line 111 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "string", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( vdefault, "default"  );
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ Define() [3/7]

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

override

Definition at line 97 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "double", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( (double)vdefault, "default"  );
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ Define() [4/7]

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

override

Definition at line 84 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "float", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( (double)vdefault, "default"  );
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ Define() [5/7]

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

override

Definition at line 71 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "float", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( (double)vdefault, "default"  );
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ Define() [6/7]

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

override

Definition at line 44 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "int", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( (double)vdefault, "default"  );
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ Define() [7/7]

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

override

Definition at line 57 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "size_t", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( (double)vdefault, "default"  );
   EndStruct();
   
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndStruct(), IsOptional(), key, and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ DefineEnum()

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

override

Definition at line 125 of file ShuttleGetDefinition.cpp.

{
   StartStruct();
   AddItem( wxString(key), "key" );
   AddItem( "enum", "type" );
   if( IsOptional() )
      AddItem( "unchanged", "default" );
   else
      AddItem( strings[vdefault].Internal(), "default"  );
   StartField( "enum" );
   StartArray();
   for( size_t i = 0; i < nStrings; i++ )
      AddItem( strings[i].Internal() );
   EndArray();
   EndField();
   EndStruct();
}

References CommandMessageTargetDecorator::AddItem(), CommandMessageTargetDecorator::EndArray(), CommandMessageTargetDecorator::EndField(), CommandMessageTargetDecorator::EndStruct(), Internal, IsOptional(), key, CommandMessageTargetDecorator::StartArray(), CommandMessageTargetDecorator::StartField(), and CommandMessageTargetDecorator::StartStruct().

Here is the call graph for this function:

◆ IsOptional()

bool ShuttleGetDefinition::IsOptional ( )

Definition at line 14 of file ShuttleGetDefinition.cpp.

                                     {
   bool result = pOptionalFlag !=NULL;
   pOptionalFlag = NULL;
   return result;
}

References SettingsVisitorBase< Const >::pOptionalFlag.

Referenced by Define(), and DefineEnum().

Here is the caller graph for this function:

◆ Optional()

ConstSettingsVisitor & ShuttleGetDefinition::Optional ( const bool & var )

override

Definition at line 21 of file ShuttleGetDefinition.cpp.

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

References SettingsVisitorBase< Const >::pOptionalFlag.

Member Data Documentation

◆ Result

wxString ShuttleGetDefinition::Result

Definition at line 25 of file ShuttleGetDefinition.h.

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShuttleGetDefinition()

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()

◆ IsOptional()

◆ Optional()

Member Data Documentation

◆ Result