Shuttle Class Reference

Moves data from one place to another, converting it as required. More...

#include <Shuttle.h>

Inheritance diagram for Shuttle:

Public Member Functions
	Shuttle ()
virtual	~Shuttle ()
virtual bool	TransferBool (const wxString &Name, bool &bValue, const bool &bDefault)
virtual bool	TransferFloat (const wxString &Name, float &fValue, const float &fDefault)
virtual bool	TransferDouble (const wxString &Name, double &dValue, const double &dDefault)
virtual bool	TransferInt (const wxString &Name, int &iValue, const int &iDefault)
virtual bool	TransferInt (const wxString &Name, wxLongLong_t &iValue, const wxLongLong_t &iDefault)
virtual bool	TransferLongLong (const wxString &Name, wxLongLong_t &iValue, const wxLongLong_t &iDefault)
virtual bool	TransferString (const wxString &Name, wxString &strValue, const wxString &strDefault)
virtual bool	TransferEnum (const wxString &Name, int &iValue, const int nChoices, const wxString *pFirstStr)
virtual bool	TransferWrappedType (const wxString &Name, WrappedType &W)
virtual bool	ExchangeWithMaster (const wxString &Name)

Public Attributes
bool	mbStoreInClient
wxString	mValueString

Detailed Description

Moves data from one place to another, converting it as required.

Shuttle provides a base class for transfering parameter data into and out of clasess into some other structure. This is a common requirement and is needed for:

• Prefs data
• Command line parameter data
• Project data in XML

The 'Master' is the string side of the shuttle transfer, the 'Client' is the binary data side of the transfer.

See Also

ShuttleBase

ShuttleGui

Definition at line 20 of file Shuttle.h.

Constructor & Destructor Documentation

Shuttle::Shuttle

(

)

Definition at line 75 of file Shuttle.cpp.

{
}

virtual Shuttle::~Shuttle ( )

inlinevirtual

Definition at line 24 of file Shuttle.h.

{}

Member Function Documentation

bool Shuttle::ExchangeWithMaster ( const wxString &  Name )

virtual

Reimplemented in ShuttleParams, ShuttleCli, and ShuttlePrefs.

Definition at line 259 of file Shuttle.cpp.

Referenced by TransferBool(), TransferDouble(), TransferEnum(), TransferFloat(), TransferInt(), TransferLongLong(), TransferString(), and TransferWrappedType().

{
   // ExchangeWithMaster() will usually be over-ridden
   // in derived classes.  We could have made it an
   // abstract function.
   wxASSERT( false );
   return true;
}

bool Shuttle::TransferBool ( const wxString &  Name, bool &  bValue, const bool &  bDefault  )

virtual

Reimplemented in ShuttlePrefs.

Definition at line 79 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

{
   if( mbStoreInClient )
   {
      bValue = bDefault;
      if( ExchangeWithMaster( Name ))
      {
         if( !mValueString.IsEmpty() )
            bValue = mValueString.GetChar(0) == wxT('y');
      }
   }
   else
   {
      mValueString = (bValue==0) ? wxT("no"):wxT("yes");
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferDouble ( const wxString &  Name, double &  dValue, const double &  dDefault  )

virtual

Reimplemented in ShuttlePrefs.

Definition at line 117 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

{
   if( mbStoreInClient )
   {
      dValue = dDefault;
      if( ExchangeWithMaster( Name ))
      {
         if( !mValueString.IsEmpty() )
            dValue = wxAtof( mValueString );
      }
   }
   else
   {
      //%f is format string for double
      mValueString = wxString::Format(wxT("%f"),dValue);
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferEnum ( const wxString &  Name, int &  iValue, const int  nChoices, const wxString *  pFirstStr  )

virtual

Definition at line 181 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

{
   if( mbStoreInClient )
   {
      iValue = 0;// default index if none other selected.
      if( ExchangeWithMaster( Name ))
      {
         wxString str = mValueString;
         if( str.Left( 1 ) == wxT('"') && str.Right( 1 ) == wxT('"') )
         {
            str = str.Mid( 2, str.Length() - 2 );
         }

         for( int i = 0; i < nChoices; i++ )
         {
            if( str.IsSameAs( pFirstStr[i] ))
            {
               iValue = i;
               break;
            }
         }
      }
   }
   else
   {
      //TIDY-ME: Out of range configuration values are silently discarded...
      if( iValue > nChoices )
         iValue = 0;
      if( iValue < 0 )
         iValue = 0;
      mValueString = pFirstStr[iValue];
      if( mValueString.Find( wxT(' ') ) != wxNOT_FOUND )
      {
         mValueString = wxT('"') + pFirstStr[iValue] + wxT('"');  //strings have quotes around them
      }
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferFloat ( const wxString &  Name, float &  fValue, const float &  fDefault  )

virtual

Definition at line 98 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

{
   if( mbStoreInClient )
   {
      fValue = fDefault;
      if( ExchangeWithMaster( Name ))
      {
         if( !mValueString.IsEmpty() )
            fValue = wxAtof( mValueString );
      }
   }
   else
   {
      mValueString = wxString::Format(wxT("%f"),fValue);
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferInt ( const wxString &  Name, int &  iValue, const int &  iDefault  )

virtual

Reimplemented in ShuttlePrefs.

Definition at line 137 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

{
   if( mbStoreInClient )
   {
      iValue = iDefault;
      if( ExchangeWithMaster( Name ))
      {
         iValue = wxAtoi( mValueString );
      }
   }
   else
   {
      mValueString = wxString::Format(wxT("%i"),iValue);
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferInt ( const wxString &  Name, wxLongLong_t &  iValue, const wxLongLong_t &  iDefault  )

virtual

Definition at line 156 of file Shuttle.cpp.

References TransferLongLong().

{
   return TransferLongLong(Name, iValue, iDefault);
}

bool Shuttle::TransferLongLong ( const wxString &  Name, wxLongLong_t &  iValue, const wxLongLong_t &  iDefault  )

virtual

Todo:

Fix for long long values.

Definition at line 161 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

Referenced by TransferInt().

{
   if( mbStoreInClient )
   {
      iValue = iDefault;
      if( ExchangeWithMaster( Name ))
      {
         iValue = wxAtoi( mValueString );
      }
   }
   else
   {
      mValueString = wxString::Format(wxT("%lld"), (long long) iValue);
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferString ( const wxString &  Name, wxString &  strValue, const wxString &  strDefault  )

virtual

Reimplemented in ShuttlePrefs.

Definition at line 222 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, and mValueString.

Referenced by CommandBuilder::BuildCommand().

{
   if( mbStoreInClient )
   {
      if( ExchangeWithMaster( Name ))
      {
         strValue = mValueString;
      }
      else
         return false;
   }
   else
   {
      mValueString = wxT('"') + strValue + wxT('"');  //strings have quotes around them
      return ExchangeWithMaster( Name );
   }
   return true;
}

bool Shuttle::TransferWrappedType ( const wxString &  Name, WrappedType &  W  )

virtual

Reimplemented in ShuttlePrefs.

Definition at line 241 of file Shuttle.cpp.

References ExchangeWithMaster(), mbStoreInClient, mValueString, WrappedType::ReadAsString(), and WrappedType::WriteToAsString().

{
   if( mbStoreInClient )
   {
      if( ExchangeWithMaster( Name ))
      {
         W.WriteToAsString( mValueString );
      }
   }
   else
   {
      mValueString = W.ReadAsString();
      return ExchangeWithMaster( Name );
   }
   return true;
}

Member Data Documentation

bool Shuttle::mbStoreInClient

Definition at line 27 of file Shuttle.h.

Referenced by CommandBuilder::BuildCommand(), ShuttleCli::ExchangeWithMaster(), ShuttlePrefs::TransferBool(), TransferBool(), ShuttlePrefs::TransferDouble(), TransferDouble(), TransferEnum(), TransferFloat(), ShuttlePrefs::TransferInt(), TransferInt(), TransferLongLong(), ShuttlePrefs::TransferString(), TransferString(), and TransferWrappedType().

wxString Shuttle::mValueString

Definition at line 28 of file Shuttle.h.

Referenced by ShuttleCli::ExchangeWithMaster(), TransferBool(), TransferDouble(), TransferEnum(), TransferFloat(), TransferInt(), TransferLongLong(), TransferString(), and TransferWrappedType().

---

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

• Shuttle.h
• Shuttle.cpp