STFF-Replay.h

Go to the documentation of this file.

///
/// @file   STFF-Replay.h
///
/// Header file for the STFF::Replay class.
///
/// @copyright
/// Copyright (c) 2012-2015 Sifferman Technology, LLC.  All rights reserved.
///

#ifndef STFF_Replay_h_
#define STFF_Replay_h_


// TODO:
// Need the following member functions:
// - Play() ?
// - GetDurationMs()
// - SetCounterMs()
// - GetCounterMs()
// Do we want to specify the frequency to play (200 kHz/ 50 kHz)?
// In the original data, the frequency was specified by STFishFinder::SetFrequencyMode().
// Maybe when recording, we save the frequency mode in the Replay object,
// and when playing back, the frequency mode is initialized from the Replay object.
//
// Maybe when playing back, we give the user the choice to playback with original settings,
// or to playback with current settings.  (Now we're back to full API playback)
//
// Simulator mode doesn't need to track original settings.  Only current settings
// matter.
//
// A Replay object should contain API calls, not Json messages.
//
// When creating a Replay object, store the API version in the object, in case it
// is played back with a different API version.
//


namespace STFF {

    ////////////////////////////////////////////////////////////////////
    /// @class Replay
    /// Replay class.
    ///
    /// The Replay class contains data and methods pertaining to the
    /// recording and playback of data received from a black box
    /// fish finder.
    ///
    class Replay {

    public:

        ////////////////////////////////////////////////////////////////////
        /// @fn Replay ()
        ///
        /// This is the @ref Replay class constructor.
        /// The Replay object created with this constructor
        /// is empty, containing no data.
        ///
        /// @returns    (not applicable)
        ///
        ///
        Replay ();


        ////////////////////////////////////////////////////////////////////
        /// @fn ~Replay ()
        ///
        /// This is the @ref Replay destructor.
        ///
        /// @returns    (not applicable)
        ///
        ~Replay ();


        ////////////////////////////////////////////////////////////////////
        /// @fn Replay (const Replay &)
        ///
        /// This is the @ref Replay copy constructor.
        ///
        /// @param      const Replay &
        ///             reference to an existing Replay object
        ///
        /// @returns    Replay
        ///             a new Replay object that is a copy of the
        ///             original
        ///
        Replay (const Replay &);


        ////////////////////////////////////////////////////////////////////
        /// @fn Replay &operator= (const Replay &)
        ///
        /// This is the @ref Replay assignment operator.
        ///
        /// @param      const Replay &
        ///             reference to a first existing Replay object
        ///             (right hand side of assignment)
        ///
        /// @returns    const Replay &
        ///             reference to a second existing Replay object
        ///             (left hand side of assignment)
        ///
        const Replay &operator= (const Replay &);


    private:

        class impl;
        impl *m_pimpl;

    };  // class Replay

}       // namespace STFF

#endif  // #defined (STFF_Replay_h_)