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 transferring parameter data into and out of classes 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 70 of file Shuttle.h.

Constructor & Destructor Documentation

Shuttle()

Shuttle::Shuttle

(

)

Definition at line 72 of file Shuttle.cpp.

{
}

~Shuttle()

virtual Shuttle::~Shuttle ( )

inlinevirtual

Definition at line 74 of file Shuttle.h.

{}

Member Function Documentation

ExchangeWithMaster()

bool Shuttle::ExchangeWithMaster ( const wxString &  Name )

virtual

Reimplemented in ShuttleCli, and ShuttlePrefs.

Definition at line 256 of file Shuttle.cpp.

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

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

Here is the caller graph for this function:

TransferBool()

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

virtual

Reimplemented in ShuttlePrefs.

Definition at line 76 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and wxT().

Here is the call graph for this function:

TransferDouble()

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

virtual

Reimplemented in ShuttlePrefs.

Definition at line 114 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and wxT().

Here is the call graph for this function:

TransferEnum()

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

virtual

Definition at line 178 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, str, and wxT().

Here is the call graph for this function:

TransferFloat()

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

virtual

Definition at line 95 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and wxT().

Here is the call graph for this function:

TransferInt() [1/2]

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

virtual

Reimplemented in ShuttlePrefs.

Definition at line 134 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and wxT().

Here is the call graph for this function:

TransferInt() [2/2]

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

virtual

Definition at line 153 of file Shuttle.cpp.

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

References TransferLongLong().

Here is the call graph for this function:

TransferLongLong()

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

virtual

Todo:

Fix for long long values.

Definition at line 158 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and wxT().

Referenced by TransferInt().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferString()

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

virtual

Reimplemented in ShuttlePrefs.

Definition at line 219 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and wxT().

Referenced by CommandBuilder::BuildCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferWrappedType()

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

virtual

Reimplemented in ShuttlePrefs.

Definition at line 238 of file Shuttle.cpp.

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

References ExchangeWithMaster(), mbStoreInClient, mValueString, and W.

Here is the call graph for this function:

Member Data Documentation

mbStoreInClient

bool Shuttle::mbStoreInClient

Definition at line 77 of file Shuttle.h.

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

mValueString

wxString Shuttle::mValueString

Definition at line 78 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