ttxpagestream.h

#ifndef _TTXPAGESTREAM_H_
#define _TTXPAGESTREAM_H_

#include <sys/stat.h>

#include "ttxpage.h"
#include "packet.h"
#include "masterClock.h"

/** @brief Extends TTXPage to allow Service to iterate through this page.
 *  It adds iterators to the page and also timing control if it is a carousel.
 *  It also has features to help add, remove and update pages in a service.
 */
class TTXPageStream : public TTXPage
{
    public:
        /** Used to mark pages for deleting
         *  Pages are set to NOTFOUND at the start of each pass
         *  As pages are matched with files on drive they are set to FOUND
         *  At the end of a pass the file status is set to MARKED. The Service thread can now delete the page object.
         */
        enum Status
        {
          NEW,      // Just created
          NOTFOUND, // Not found yet
          FOUND,    // Matched on drive
          MARKED,   // To be deleted
          GONE      // Safe to delete
        };

        /** Default constructor. Don't call this */
        TTXPageStream();
        /** Default destructor */
        virtual ~TTXPageStream();

        /** The normal constructor
         */
        TTXPageStream(std::string filename);

        bool GetCarouselFlag() { return _isCarousel; }
        void SetCarouselFlag(bool val) { _isCarousel = val; }

        bool GetSpecialFlag() { return _isSpecial; }
        void SetSpecialFlag(bool val) { _isSpecial = val; }
        
        bool GetNormalFlag() { return _isNormal; }
        void SetNormalFlag(bool val) { _isNormal = val; }
        
        bool GetUpdatedFlag() { return _isUpdated; }
        void SetUpdatedFlag(bool val) { _isUpdated = val; }
        
        int GetUpdateCount() {return _updateCount;}
        void IncrementUpdateCount();

        /** Is the page a carousel?
         *  Don't confuse this with the _isCarousel flag which is used to mark when a page changes between single/carousel
         * \return True if there are subpages
         */
        bool IsCarousel();

        /** Set the time when this carousel expires
         *  which is the current time plus the cycle time
         *  or the number of page cycles remaining
         */
        void SetTransitionTime(int cycleTime);

        /** Used to time carousels
         *  If StepCycles is set, decrement page cycle count
         *  @return true if it is time to change carousel page
         */
        bool Expired(bool StepCycles=false);

        /** Step to the next page in a carousel
         *  Updates _CarouselPage;
         */
        void StepNextSubpage();

        // step to next subpage but don't loop back to the start
        void StepNextSubpageNoLoop();

        /** This is used by mag */
        TTXPage* GetCarouselPage(){return _CarouselPage;};

        /** Get the row from the page.
        * Carousels and main sequence pages are managed differently
        */
        TTXLine* GetTxRow(uint8_t row);

        // The time that the file was modified.
        time_t GetModifiedTime(){return _modifiedTime;};
        void SetModifiedTime(time_t timeVal){_modifiedTime=timeVal;};

        bool LoadPage(std::string filename);

        /**
         * @brief Set the flag used to detect file updates
         * All files that are not MARKED are set NOT FOUND the start of a pass
         * As files are matched with those on the drive are marked as FOUND
         * At the end of the pass, any pages that are NOT FOUND are MARKED for delete
         */
        void SetState(Status state){_fileStatus=state;};
        /**
         * @return Flag used to monitor file status
         */
        Status GetStatusFlag(){return _fileStatus;};

        /** Used to enable list->remove
         */
        bool operator==(const TTXPageStream& rhs) const;

        // Todo: These are migrating to TTXPage
        void SetSelected(bool value){_Selected=value;}; /// Set the selected state to value
        bool Selected(){return _Selected;}; /// Return the selected state
        
        void SetPacket29Flag(bool value){_loadedPacket29=value;}; // Used by PageList::CheckForPacket29OrCustomHeader
        bool GetPacket29Flag(){return _loadedPacket29;}; // Used by PageList::DeleteOldPages
        
        void SetCustomHeaderFlag(bool value){_loadedCustomHeader=value;}; // Used by PageList::CheckForPacket29OrCustomHeader
        bool GetCustomHeaderFlag(){return _loadedCustomHeader;};

    protected:

    private:
        // Carousel control
        // TTXPageStream* _CurrentPage; //!< Member variable "_currentPage" points to the subpage being transmitted

        time_t _transitionTime; // Records when the next carousel transition is due
        int _cyclesRemaining; // As above for cycle mode

        TTXPage* _CarouselPage; /// Pointer to the current subpage of a carousel

        // Things that affect the display list
        time_t _modifiedTime;   /// Poll this in case the source file changes (Used to detect updates)
        Status _fileStatus; /// Used to mark if we found the file. (Used to detect deletions)
        
        bool _loadedPacket29; // Packet 29 for magazine was loaded from this page. Should only be set on one page in each magazine.
        
        bool _loadedCustomHeader; // Custom header was loaded from this page. Should only be set on one page in each magazine.
        
        bool _Selected;   /// Marked as selected by the inserter P command

        bool _isCarousel;
        bool _isSpecial;
        bool _isNormal;
        bool _isUpdated;

        int _updateCount; // update counter for special pages.
};

#endif // _TTXPAGESTREAM_H_