ms_cronoptions.hpp

/*
##############################################################################
# file: ms_cronoptions.hpp                                                   #
# 'msparser' toolkit                                                         #
# Represents parameters from cron-section of 'mascot.dat' configuration file #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2003 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_cronoptions.hpp         $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_CRONOPTIONS_HPP
#define MS_CRONOPTIONS_HPP


#include <string>
#include <vector>


namespace matrix_science {


    class MS_MASCOTRESFILE_API ms_cronjob
    {
        friend class ms_datfile;
        friend class ms_cronoptions;

    public:
        ms_cronjob();

        ms_cronjob(const ms_cronjob& src);

        ~ms_cronjob();

        void defaultValues();

        void copyFrom(const ms_cronjob* right);

#ifndef SWIG

        ms_cronjob& operator=(const ms_cronjob& right);
#endif

        bool isEnabled() const;

        void setEnabled(const bool enabled);

        bool isMinute(const int min) const;

        void setMinute(const int min, const bool value);

        bool isHour(const int hour) const;

        void setHour(const int hour, const bool value);

        bool isDayOfMonth(const int day) const;

        void setDayOfMonth(const int day, const bool value);

        bool isMonthOfYear(const int month) const;

        void setMonthOfYear(const int month, const bool value);

        bool isDayOfWeek(const int day) const;

        void setDayOfWeek(const int day, const bool value);

        std::string getCommandStr() const;

        void setCommandStr(const char* str);

        // used internally
        std::string getStringValue() const;

    private:
        bool  enabled_;               /* If false, then a #[space] at start of line */
        bool  minute_[60];            /* index of 0-59 - Value of true means do it  */
        bool  hour_[24];              /* index of 0-23 - Value of true means do it  */
        bool  dayOfMonth_[32];        /* index of 1-31 - Value of true means do it  */
        bool  monthOfYear_[13];       /* index of 1-12 - Value of true means do it  */
        bool  dayOfWeek_[7];          /* index of  0-6 (0 = Sunday)                 */
        std::string szCommand_;

        void setCustomString();
        std::string customString_;
    }; // class ms_cronjob


    class MS_MASCOTRESFILE_API ms_cronoptions: public ms_customproperty
    {
        friend class ms_datfile;
    public:

        ms_cronoptions();

        ms_cronoptions(const ms_cronoptions& src);

        ~ms_cronoptions();

        void defaultValues();

        void copyFrom(const ms_cronoptions* right);

#ifndef SWIG

        ms_cronoptions& operator=(const ms_cronoptions& right);
#endif

        bool isSectionAvailable() const;

        void setSectionAvailable(const bool value);

        bool isCronEnabled() const;

        void setCronEnabled(const bool value);

        int getNumberOfCronJobs() const;

        const ms_cronjob getCronJob(const int idx) const;

        bool setCronJob(const int idx, const ms_cronjob job);

        bool deleteCronJob(const int idx);

        void clearCronJobs();

        void appendCronJob(const ms_cronjob* job);

        int getLoggingLevel() const;

        bool setLoggingLevel(const int level);

        std::string getLogFileName() const;

        bool setLogFileName(const std::string & fileName);


#ifdef SUPPRESS_MS_CUSTOMPROPERTY_INHERITANCE
#include "suppress_ms_customproperty.hpp"
#endif

    private:
        int findProperty(const ms_cronjob & job) const;
        bool getPropertyNameValue(const ms_cronjob & job, std::string & name, std::string & value) const;
        bool                        sectionAvailable_;
        bool                        cronEnabled_;
        std::vector< ms_cronjob  >  cronJobArray_;
        int                         loggingLevel_;
        std::string                 logFileName_;
    }; // ms_cronoptions // end of config_group
} // namespace matrix_science

#endif // MS_CRONOPTIONS_HPP

/*------------------------------- End of File -------------------------------*/