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 ()
void	SetTo (wxString &InStr)
void	SetTo (int &InInt)
void	SetTo (double &InDouble)
void	SetTo (bool &InBool)
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)
bool	ValuesMatch (const WrappedType &W)
void	WriteToAsWrappedType (const WrappedType &W)
void	Init ()

Public Attributes
teWrappedType	eWrappedType
wxString *	mpStr
int *	mpInt
double *	mpDouble
bool *	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 31 of file WrappedType.h.

Constructor & Destructor Documentation

WrappedType::WrappedType ( wxString &  InStr )

inline

Definition at line 35 of file WrappedType.h.

{ SetTo(InStr);   };

WrappedType::WrappedType ( int &  InInt )

inline

Definition at line 36 of file WrappedType.h.

{      SetTo(InInt);   };

WrappedType::WrappedType ( double &  InDouble )

inline

Definition at line 37 of file WrappedType.h.

{SetTo(InDouble);};

WrappedType::WrappedType ( bool &  InBool )

inline

Definition at line 38 of file WrappedType.h.

{    SetTo(InBool);  };

WrappedType::WrappedType ( )

inline

Definition at line 39 of file WrappedType.h.

{ Init();}

Member Function Documentation

void WrappedType::Init

(

)

Definition at line 69 of file WrappedType.cpp.

References eWrappedNotSet, eWrappedType, mpBool, mpDouble, mpInt, and mpStr.

Referenced by ShuttleGuiBase::EndRadioButtonGroup().

{
   eWrappedType = eWrappedNotSet;
   mpStr = NULL;
   mpInt = NULL;
   mpDouble = NULL;
   mpBool = NULL;
}

bool WrappedType::IsString

(

)

Returns

true iff the wrapped type is a string.

Definition at line 34 of file WrappedType.cpp.

References eWrappedString, and eWrappedType.

Referenced by ShuttleGuiBase::TieChoice().

{
   return eWrappedType == eWrappedString;
}

bool WrappedType::ReadAsBool

(

)

Definition at line 188 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieCheckBox(), and ShuttleGuiBase::TieCheckBoxOnRight().

{
   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
}

double WrappedType::ReadAsDouble

(

)

Definition at line 162 of file WrappedType.cpp.

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

{
   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
}

int WrappedType::ReadAsInt

(

)

Definition at line 132 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieChoice(), ShuttleGuiBase::TieSlider(), and ShuttleGuiBase::TieSpinCtrl().

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

wxString WrappedType::ReadAsString

(

)

Definition at line 106 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieCheckBox(), ShuttleGuiBase::TieCheckBoxOnRight(), ShuttleGuiBase::TieChoice(), ShuttleGuiBase::TieNumericTextBox(), ShuttleGuiBase::TieTextBox(), and Shuttle::TransferWrappedType().

{
   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
}

void WrappedType::SetTo ( wxString &  InStr )

inline

Definition at line 41 of file WrappedType.h.

References eWrappedString.

Referenced by ShuttleGuiBase::StartRadioButtonGroup().

{ Init();mpStr=&InStr;       eWrappedType = eWrappedString;}

void WrappedType::SetTo ( int &  InInt )

inline

Definition at line 42 of file WrappedType.h.

References eWrappedInt.

{      Init();mpInt=&InInt;       eWrappedType = eWrappedInt;};

void WrappedType::SetTo ( double &  InDouble )

inline

Definition at line 43 of file WrappedType.h.

References eWrappedDouble.

{Init();mpDouble=&InDouble; eWrappedType = eWrappedDouble;};

void WrappedType::SetTo ( bool &  InBool )

inline

Definition at line 44 of file WrappedType.h.

References eWrappedBool.

{    Init();mpBool=&InBool;     eWrappedType = eWrappedBool;};

bool WrappedType::ValuesMatch

(

const WrappedType &

W

)

Parameters

W	Wrapped type to compare

Returns

true iff types and values are the same.

Definition at line 41 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieRadioButton().

{
   if( W.eWrappedType != eWrappedType )
      return false;
   switch( eWrappedType )
   {
   case eWrappedString:
      return *W.mpStr == *mpStr;
      break;
   case eWrappedInt:
      return *W.mpInt == *mpInt;
      break;
   case eWrappedDouble:
      return *W.mpDouble == *mpDouble;
      break;
   case eWrappedBool:
      return *W.mpBool == *mpBool;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
   return false;
}

void WrappedType::WriteToAsBool

(

const bool

InBool

)

Definition at line 297 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieCheckBox(), and ShuttleGuiBase::TieCheckBoxOnRight().

{
   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;
   }
}

void WrappedType::WriteToAsDouble

(

const double

InDouble

)

Definition at line 270 of file WrappedType.cpp.

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

{
   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;
   }
}

void WrappedType::WriteToAsInt

(

const int

InInt

)

Definition at line 245 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieChoice(), ShuttleGuiBase::TieSlider(), and ShuttleGuiBase::TieSpinCtrl().

{
   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;
   }
}

void WrappedType::WriteToAsString

(

const wxString &

InStr

)

Definition at line 216 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieChoice(), ShuttleGuiBase::TieNumericTextBox(), ShuttleGuiBase::TieTextBox(), and Shuttle::TransferWrappedType().

{
   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;
   }
}

void WrappedType::WriteToAsWrappedType

(

const WrappedType &

W

)

Definition at line 78 of file WrappedType.cpp.

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

Referenced by ShuttleGuiBase::TieRadioButton().

{
   wxASSERT( W.eWrappedType == eWrappedType );
   switch( eWrappedType )
   {
   case eWrappedString:
      *mpStr = *W.mpStr;
      break;
   case eWrappedInt:
      *mpInt = *W.mpInt;
      break;
   case eWrappedDouble:
      *mpDouble = *W.mpDouble;
      break;
   case eWrappedBool:
      *mpBool = *W.mpBool;
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
}

Member Data Documentation

teWrappedType WrappedType::eWrappedType

Definition at line 64 of file WrappedType.h.

Referenced by Init(), IsString(), ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), ShuttleGuiBase::StartRadioButtonGroup(), ShuttlePrefs::TransferWrappedType(), ValuesMatch(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), WriteToAsString(), and WriteToAsWrappedType().

bool* WrappedType::mpBool

Definition at line 68 of file WrappedType.h.

Referenced by Init(), ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), ShuttlePrefs::TransferWrappedType(), ValuesMatch(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), WriteToAsString(), and WriteToAsWrappedType().

double* WrappedType::mpDouble

Definition at line 67 of file WrappedType.h.

Referenced by Init(), ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), ShuttlePrefs::TransferWrappedType(), ValuesMatch(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), WriteToAsString(), and WriteToAsWrappedType().

int* WrappedType::mpInt

Definition at line 66 of file WrappedType.h.

Referenced by Init(), ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), ShuttlePrefs::TransferWrappedType(), ValuesMatch(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), WriteToAsString(), and WriteToAsWrappedType().

wxString* WrappedType::mpStr

Definition at line 65 of file WrappedType.h.

Referenced by Init(), ReadAsBool(), ReadAsDouble(), ReadAsInt(), ReadAsString(), ShuttlePrefs::TransferWrappedType(), ValuesMatch(), WriteToAsBool(), WriteToAsDouble(), WriteToAsInt(), WriteToAsString(), and WriteToAsWrappedType().

---

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

• WrappedType.h
• WrappedType.cpp