MTimeRule.h

Go to the documentation of this file.

/*****************************************************************************
 **
 **  Header file for Muster API Time rule object lib
 **
 **  Name    : MTimeRule.h
 **  Author  : Leonardo Bernardini
 **  Version : 1.0, Sat Mar 2nd 2013
 **
 **  Copyright 2000-2014, Virtual Vertex
 **  All Rights Reserved.
 **
 **  This file contains UNPUBLISHED PROPRIETARY SOURCE CODE.
 **  The contents of this file may not be disclosed to third parties, copied
 **  or duplicated in any form, in whole or in part, without the prior written
 **  permission of the author.
 **
 *****************************************************************************/
#ifndef MTIMERULE_H
#define MTIMERULE_H

#ifdef WIN32
// Windows definitions
#ifdef MCLIENTLIB_EXPORTS
#define MCLIENTLIB_API __declspec(dllexport)
#else
#define MCLIENTLIB_API __declspec(dllimport)
#endif
#else

#ifndef MCLIENTLIB_EXPORTS
#ifdef LINUX
#define MCLIENTLIB_API
#else
#define MCLIENTLIB_API
#endif
#else
#define MCLIENTLIB_API
#endif
#endif

// Disable STL Export warning, member is private, we don't need direct access from the DLL client
#if defined(_WIN32)
#pragma warning(disable: 4251)
#endif // _WIN32

#include <string>
#include <vector>
#include <list>

namespace MClientLib {
    
    class MCLIENTLIB_API MTimeRule {
    private:
        int type;
        int availability;
        long long int startingTime;
        long long int endingTime;
        

    public:

        enum kTimeRulesEvaluation {
            kTimeRuleMatch,
            kTimeRuleDontMatch,
            kTimeRuleNotPertinent
        };

        enum kTimeRulesType {
            kTimeRuleDayRange,
            kTimeRuleTimeSpan
        };

        enum kTimeRulesAvailability {
            kTimeRuleNotAvailable,
            kTimeRuleAvailable
        };

        MTimeRule();
        void setType(int ruleType);
        int getType();

        void setAvailability(int ruleAvailability);
        int getAvailability();

        void getRuleTimeSpan(long long int& _startingTime, long long int& _endingTime);
        void setRuleTimeSpan(long long int _startingTime, long long int _endingTime);
        void setRuleDayRange(int startingDay, int startingHour, int startingMinutes,
            int endingDay,int endingHours, int endingMinutes);
        void getRuleDayRange(int& startingDay, int& startingHour, int& startingMinutes,
            int& endingDay,int& endingHours, int& endingMinutes);

        static std::vector<MTimeRule> Unmarshall(const std::string& );
        static std::string Marshall(const std::vector<MTimeRule>& list);

#ifndef SWIG
        void encodeTree(void* _pt, std::string (*encodeFunc)(const std::string &),int encoding) const;
        void decodeTree(void* _pt);
        int Evaluate() const;
        static int Evaluate(const std::vector<MTimeRule>& rules,int defaultValue = kTimeRuleNotPertinent);
        static void encodeTreeList(void* _pt, std::string (*encodeFunc)(const std::string &),int encoding,const std::vector<MTimeRule>& list) ;
        static std::vector<MTimeRule> decodeTreeList(void* _pt);
#endif
    } ;
}

#endif