SessionSchedule.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/
 
#pragma once
 
#include <OnixS/B3/BOE/ABI.h>
 
#include <string>
#include <vector>
 
namespace OnixS {
namespace B3 {
namespace BOE {
namespace Scheduling {

struct ONIXS_B3_BOE_EXPORTED SequenceNumberResetPolicy
{
    enum Enum
    {
        Never,

        Weekly
    };

    static Enum parse(const std::string & value);

    static std::string toString(Enum value);
};

struct ONIXS_B3_BOE_EXPORTED DayOfWeek
{
    enum Enum
    {
        Sunday,
        Monday,
        Tuesday,
        Wednesday,
        Thursday,
        Friday,
        Saturday,
        Total
    };

    static Enum parse(const std::string & value);

    static std::string toString(Enum value);

    static Enum now();

    static Enum utcNow();
};

typedef int Hours;

typedef int Minutes;

typedef int Seconds;

class ONIXS_B3_BOE_EXPORTED TimeOfDay
{
public:
    TimeOfDay() ONIXS_B3_BOE_NOTHROW;
 
    TimeOfDay(Hours hours, Minutes minutes, Seconds = 0) ONIXS_B3_BOE_NOTHROW;

    Hours hours() const ONIXS_B3_BOE_NOTHROW;

    Minutes minutes() const ONIXS_B3_BOE_NOTHROW;

    Seconds seconds() const ONIXS_B3_BOE_NOTHROW;

    Seconds sinceMidnight() const ONIXS_B3_BOE_NOTHROW;

    std::string toString() const;

    bool operator == (const TimeOfDay & other) const ONIXS_B3_BOE_NOTHROW;

    bool operator != (const TimeOfDay & other) const ONIXS_B3_BOE_NOTHROW;

    static TimeOfDay now();

    static TimeOfDay midnight() ONIXS_B3_BOE_NOTHROW;

    static TimeOfDay bad();

    static TimeOfDay parse(const std::string &);
 
private:
    Seconds seconds_;
 
    explicit TimeOfDay(Seconds) ONIXS_B3_BOE_NOTHROW;
};
 
inline
Seconds TimeOfDay::sinceMidnight() const ONIXS_B3_BOE_NOTHROW
{
    return seconds_;
}
 
inline
bool TimeOfDay::operator == (const TimeOfDay & other) const ONIXS_B3_BOE_NOTHROW
{
    return seconds_ == other.seconds_;
}
 
inline
bool TimeOfDay::operator != (const TimeOfDay & other) const ONIXS_B3_BOE_NOTHROW
{
    return seconds_ != other.seconds_;
}

typedef TimeOfDay TimeOfDayOfWeek[DayOfWeek::Total];

class ONIXS_B3_BOE_EXPORTED SessionSchedule
{
public:
    SessionSchedule(DayOfWeek::Enum firstDay, DayOfWeek::Enum lastDay, TimeOfDay logonTime, TimeOfDay logoutTime, SequenceNumberResetPolicy::Enum seqNumberResetPolicy = SequenceNumberResetPolicy::Enum::Weekly);
 
    SessionSchedule(const SessionSchedule & other);

    TimeOfDay logonTime(DayOfWeek::Enum day) const ONIXS_B3_BOE_NOTHROW;

    SessionSchedule& logonTime(DayOfWeek::Enum day, TimeOfDay time) ONIXS_B3_BOE_NOTHROW;

    TimeOfDay logoutTime(DayOfWeek::Enum day) const ONIXS_B3_BOE_NOTHROW;

    SessionSchedule &logoutTime(DayOfWeek::Enum day, TimeOfDay time) ONIXS_B3_BOE_NOTHROW;

    DayOfWeek::Enum resetDay() const ONIXS_B3_BOE_NOTHROW;

    SequenceNumberResetPolicy::Enum sequenceNumberResetPolicy() const ONIXS_B3_BOE_NOTHROW;
 
    SessionSchedule & operator = (const SessionSchedule & other);
 
private:
    friend class SessionStateChanger;
 
    TimeOfDayOfWeek logonTimes_;
    TimeOfDayOfWeek logoutTimes_;
 
    DayOfWeek::Enum startOfWeek_;
    SequenceNumberResetPolicy::Enum seqNumberResetPolicy_;
};
 
inline
TimeOfDay SessionSchedule::logonTime(DayOfWeek::Enum day) const ONIXS_B3_BOE_NOTHROW
{
    return logonTimes_[day];
}
 
inline
SessionSchedule &SessionSchedule::logonTime(DayOfWeek::Enum day, TimeOfDay logonTime) ONIXS_B3_BOE_NOTHROW
{
    logonTimes_[day] = logonTime;
    return *this;
}
 
inline
TimeOfDay SessionSchedule::logoutTime(DayOfWeek::Enum day) const ONIXS_B3_BOE_NOTHROW
{
    return logoutTimes_[day];
}
 
inline
SessionSchedule& SessionSchedule::logoutTime(DayOfWeek::Enum day, TimeOfDay logoutTime) ONIXS_B3_BOE_NOTHROW
{
    logoutTimes_[day] = logoutTime;
    return *this;
}
 
inline
DayOfWeek::Enum SessionSchedule::resetDay() const ONIXS_B3_BOE_NOTHROW
{
    return startOfWeek_;
}
 
inline
SequenceNumberResetPolicy::Enum SessionSchedule::sequenceNumberResetPolicy() const ONIXS_B3_BOE_NOTHROW
{
    return seqNumberResetPolicy_;
}
}
}
}
}