WrappedType Class Reference

Used in type conversions, this wrapper for ints, strings, doubles and enums provides conversions between all the types. Functions that work on wrapped types can quickly be reused to work on any of these types. This cuts out a lot of repetitive code. More...

#include <WrappedType.h>

Public Member Functions
	WrappedType (wxString &InStr)
	WrappedType (int &InInt)
	WrappedType (double &InDouble)
	WrappedType (bool &InBool)
	WrappedType ()
bool	IsString ()
wxString	ReadAsString ()
int	ReadAsInt ()
double	ReadAsDouble ()
bool	ReadAsBool ()
void	WriteToAsString (const wxString &InStr)
void	WriteToAsInt (const int InInt)
void	WriteToAsDouble (const double InDouble)
void	WriteToAsBool (const bool InBool)

Public Attributes
const teWrappedType	eWrappedType
wxString *const	mpStr {}
int *const	mpInt {}
double *const	mpDouble {}
bool *const	mpBool {}

Detailed Description

Used in type conversions, this wrapper for ints, strings, doubles and enums provides conversions between all the types. Functions that work on wrapped types can quickly be reused to work on any of these types. This cuts out a lot of repetitive code.

JKC: This class grows in size with the square of the number of types it supports. It has to do all conversions between all pairs, so try to re-use existing types if you can.

It's probable that not all the cases are actually used in practice. The most heavily used will be conversions to <-> from string.

Definition at line 27 of file WrappedType.h.

Constructor & Destructor Documentation

WrappedType() [1/5]

WrappedType::WrappedType ( wxString &  InStr )

inlineexplicit

Definition at line 31 of file WrappedType.h.

      : eWrappedType{ eWrappedString }, mpStr{ &InStr }
   {}

WrappedType() [2/5]

WrappedType::WrappedType ( int &  InInt )

inlineexplicit

Definition at line 34 of file WrappedType.h.

      : eWrappedType{ eWrappedInt }, mpInt{ &InInt }
   {}

WrappedType() [3/5]

WrappedType::WrappedType ( double &  InDouble )

inlineexplicit

Definition at line 37 of file WrappedType.h.

      : eWrappedType{ eWrappedDouble }, mpDouble{ &InDouble }
   {}

WrappedType() [4/5]

WrappedType::WrappedType ( bool &  InBool )

inlineexplicit

Definition at line 40 of file WrappedType.h.

      : eWrappedType{ eWrappedBool }, mpBool{ &InBool }
   {}

WrappedType() [5/5]

WrappedType::WrappedType ( )

inlineexplicit

Definition at line 43 of file WrappedType.h.

      : eWrappedType{ eWrappedNotSet }
   {}

Member Function Documentation

IsString()

bool WrappedType::IsString

(

)

Returns

true iff the wrapped type is a string.

Definition at line 34 of file WrappedType.cpp.

{
   return eWrappedType == eWrappedString;
}

References eWrappedString, and eWrappedType.

Referenced by ShuttleGuiBase::TieRadioButton().

Here is the caller graph for this function:

ReadAsBool()

bool WrappedType::ReadAsBool

(

)

Definition at line 119 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      return mpStr->IsSameAs( wxT("true"), false ); // case free comparison.
      break;
   case eWrappedInt:
      return  *mpInt != 0;
      break;
   case eWrappedDouble:
      wxASSERT( false );// DANGEROUS USE OF WrappedType.  Can't rely on equality.
      return * mpDouble != 0.0f; // this is what the code would be...
      break;
   case eWrappedBool:
      return * mpBool;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
   return false;//Compiler pacifier
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, mpStr, and wxT().

Referenced by ShuttleGuiBase::DoTieCheckBox(), and ShuttleGuiBase::DoTieCheckBoxOnRight().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadAsDouble()

double WrappedType::ReadAsDouble

(

)

Definition at line 93 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      return Internat::CompatibleToDouble( *mpStr );
      break;
   case eWrappedInt:
      return (double)*mpInt;
      break;
   case eWrappedDouble:
      return * mpDouble;
      break;
   case eWrappedBool:
      return (* mpBool)? 1.0 : 0.0;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
   return -1.0f;//Compiler pacifier
}

References Internat::CompatibleToDouble(), eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, and mpStr.

Referenced by ShuttleGuiBase::DoTieSpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadAsInt()

int WrappedType::ReadAsInt

(

)

Definition at line 67 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
   {
      long l;
      mpStr->ToLong(&l);
      return (int) l;
   }
   case eWrappedInt:
      return *mpInt;
   case eWrappedDouble:
      return (int)*mpDouble;
   case eWrappedBool:
      return (* mpBool) ? 1 : 0;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
   return -1;//Compiler pacifier
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, and mpStr.

Referenced by ShuttleGuiBase::DoTieSlider(), and ShuttleGuiBase::DoTieSpinCtrl().

Here is the caller graph for this function:

ReadAsString()

wxString WrappedType::ReadAsString

(

)

Definition at line 41 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      return *mpStr;
      break;
   case eWrappedInt:
      return wxString::Format(wxT("%i"),*mpInt );
      break;
   case eWrappedDouble:
      return wxString::Format(wxT("%.8g"),*mpDouble );
      break;
   case eWrappedBool:
      return (* mpBool) ? wxT("true") : wxT("false" );
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
   return wxT("ERROR"); //Compiler pacifier
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, mpStr, and wxT().

Referenced by ShuttleGuiBase::DoTieCheckBox(), ShuttleGuiBase::DoTieCheckBoxOnRight(), ShuttleGuiBase::DoTieNumericTextBox(), ShuttleGuiBase::DoTieTextBox(), ShuttleGuiBase::TieCheckBoxOnRight(), and ShuttleGuiBase::TieRadioButton().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteToAsBool()

void WrappedType::WriteToAsBool

(

const bool

InBool

)

Definition at line 228 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      *mpStr = InBool ? wxT("true") : wxT("false" );
      break;
   case eWrappedInt:
      *mpInt = InBool ? 1 : 0;
      break;
   case eWrappedDouble:
      *mpDouble = InBool ? 1.0 : 0.0;
      break;
   case eWrappedBool:
      *mpBool = InBool;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, mpStr, and wxT().

Referenced by ShuttleGuiBase::DoTieCheckBox(), and ShuttleGuiBase::DoTieCheckBoxOnRight().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteToAsDouble()

void WrappedType::WriteToAsDouble

(

const double

InDouble

)

Definition at line 201 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      *mpStr = wxString::Format( wxT("%.8g"), InDouble );
      break;
   case eWrappedInt:
      *mpInt = (int)InDouble;
      break;
   case eWrappedDouble:
      *mpDouble = InDouble;
      break;
   case eWrappedBool:
      wxASSERT( false );
      * mpBool = InDouble != 0.0;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, mpStr, and wxT().

Referenced by ShuttleGuiBase::DoTieSpinControl().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteToAsInt()

void WrappedType::WriteToAsInt

(

const int

InInt

)

Definition at line 176 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      *mpStr = wxString::Format( wxT("%i"), InInt );
      break;
   case eWrappedInt:
      *mpInt = InInt;
      break;
   case eWrappedDouble:
      *mpDouble = (double)InInt;
      break;
   case eWrappedBool:
      * mpBool = (InInt !=0);
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, mpStr, and wxT().

Referenced by ShuttleGuiBase::DoTieSlider(), and ShuttleGuiBase::DoTieSpinCtrl().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteToAsString()

void WrappedType::WriteToAsString

(

const wxString &

InStr

)

Definition at line 147 of file WrappedType.cpp.

{
   switch( eWrappedType )
   {
   case eWrappedString:
      *mpStr = InStr;
      break;
   case eWrappedInt:
   {
      long l;
      InStr.ToLong(&l);
      *mpInt = (int) l;
      break;
   }
   case eWrappedDouble:
      *mpDouble = Internat::CompatibleToDouble( InStr );
      break;
   case eWrappedBool:
      *mpBool = InStr.IsSameAs( wxT("true"), false ); // case free comparison.;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
}

References Internat::CompatibleToDouble(), eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, eWrappedType, mpBool, mpDouble, mpInt, mpStr, and wxT().

Referenced by ShuttleGuiBase::DoTieNumericTextBox(), and ShuttleGuiBase::DoTieTextBox().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

eWrappedType

const teWrappedType WrappedType::eWrappedType

Definition at line 61 of file WrappedType.h.

Referenced by IsString(), ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), and WriteToAsString().

mpBool

bool* const WrappedType::mpBool {}

Definition at line 65 of file WrappedType.h.

Referenced by ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), and WriteToAsString().

mpDouble

double* const WrappedType::mpDouble {}

Definition at line 64 of file WrappedType.h.

Referenced by ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), and WriteToAsString().

mpInt

int* const WrappedType::mpInt {}

Definition at line 63 of file WrappedType.h.

Referenced by ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), and WriteToAsString().

mpStr

wxString* const WrappedType::mpStr {}

Definition at line 62 of file WrappedType.h.

Referenced by ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), and WriteToAsString().

---

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

• WrappedType.h
• WrappedType.cpp