gittask.hh

Go to the documentation of this file.

#ifndef _DRAMA2_GITTASK_INC
#define _DRAMA2_GITTASK_INC
 
/*
 * History:
     04-Jul-2014 - TJF - Original version
     30-Sep-2016 - TJF - Many changes before now.
                         Add buffer, flags, selfBytes arguments to Task
                          constructor.
                         Fix spelling error - PollRescheduleEvent().
     19-Feb-2023 - TJF - Rework to make implementation actions by methods
                          rather then objects - code becomes simpler.
                         Add ResetArgType type.
                         
 * The above ID is for Doxygen, this one has the format ACMM is looking for.
 * "@(#) $Id$"
 */
 
#include "drama.hh"
#include "Git.h"
 
namespace drama { 
    namespace git {
        enum class ResetArgEnum { Soft=0,  
                            Full,    
                            Hard,    
                            Invalid  
                        } ;
        class ResetArgLookup :  drama::gitarg::EnumLookupClass {
        public:
            unsigned int GetMaxValue() const override final {
                return (int)(ResetArgEnum::Invalid)-1; /* We don't accept invalid, want the next one down */
            }
            const char  ** GetStringArray() const override final {
                static const char *table[] = { "SOFT", "FULL", "HARD", 0 };
                return table;
            }
        };
        using ResetArgType = drama::gitarg::Enum<ResetArgLookup, ResetArgEnum>;       
        class Task : public drama::Task {
        private:
            std::string            _logSysName;
            std::string            _simEnvName;
            int                    _simLevels;
 
            // I see issues if these don't have the underscores,
            //  various sub-classes have classes of the same name
            //  and having methods here causes problems.
            drama::Request _InitialiseAction(MessageHandler *);
            drama::Request _ResetAction(MessageHandler *);
            drama::Request _SimulateLevelAction(MessageHandler *);
 
        protected:
            Parameter<std::string> _SimulateLevel;
            Parameter<float>       _TimeBase;
            Parameter<std::string> _EnqDevType;
            Parameter<std::string> _EnqDevDescr;
            Parameter<std::string> _EnqVerNum;
            Parameter<std::string> _EnqVerDate;
            Parameter<INT32>       _EnqDevNumItem;
            Parameter<INT32>       _Initialised;
            Parameter<float>       _PollPar;
 
        public:
            Task(const std::string &taskName,
                 const std::string &logSysName,
                 const std::string &verNum, 
                 const std::string &verDate,
                 const std::string &description,
                 const std::string &taskType="IDT",
                 const std::string &simVarName="",
                 int simLevels=GIT_M_SIM_ALLLEVELS,
                 int buffer=drama::Task::DefBufSize, 
                 int flags=0, 
                 int selfBytes=drama::Task::DefSelfBufSize);
 
            std::string GetLogSysName() const {
                return _logSysName;
            }
            bool IsSimulating() const;
            GitSimulationType GetSimulationLevel() const;
            std::string GetSimulationStr();
            double GetSimulationTimeBase();
 
            virtual ~Task();
 
            virtual bool PollObeyOverride(MessageHandler *messageHandler);
 
            virtual bool PollKick(MessageHandler *messageHandler);
 
            virtual void PollRescheduleEvent(MessageHandler *messageHandler);
               
            virtual void PollSignalEvent(MessageHandler *messageHandler);
                           
 
            virtual Request PollRescheduleRequest();
        };
 
    } // namespace git
    
} // namespace drama
 
#endif