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 <string>
#include <vector>
 
#include <OnixS/FIXEngine/ABI.h>
 
#if !defined (MINMAX_ABUSER)
#define UNDEF_MINMAX_ABUSER
#define MINMAX_ABUSER
#endif
 
namespace OnixS {
namespace FIX {
namespace Scheduling {
struct
    ONIXS_FIXENGINE_API
    SessionDuration {
    enum Enum {
        Day,

        Week
    };

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

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

struct
    ONIXS_FIXENGINE_API
    SequenceNumberResetPolicy {
    enum Enum {
        Never,

        Daily,

        Weekly
    };

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

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

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

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

    static std::string toString(Enum value);
};
 
// The alias of the number of hours.
typedef int Hours;
 
// The alias of the number of minutes.
typedef int Minutes;
 
// The alias of the number of seconds.
typedef int Seconds;

class ONIXS_FIXENGINE_API TimeOfDay
{
public:
    TimeOfDay();

    TimeOfDay(
        Hours hours,
        Minutes minutes,
        Seconds = 0);

    TimeOfDay(const TimeOfDay &);

    Hours hours() const;

    Minutes minutes() const;

    Seconds seconds() const;

    Seconds sinceMidnight() const;

    std::string toString() const;

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

    bool operator != (const TimeOfDay & other) const;
 
    // Reinitializes the instance from another one.
    TimeOfDay & operator = (const TimeOfDay &);

    static TimeOfDay now();

    static TimeOfDay midnight();

    static TimeOfDay bad();

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

typedef TimeOfDay TimeOfDayOfWeek[DayOfWeek::Total];

class ONIXS_FIXENGINE_API SessionSchedule
{
public:
    SessionSchedule(
        DayOfWeek::Enum firstDay,
        DayOfWeek::Enum lastDay,
        TimeOfDay logonTime,
        TimeOfDay logoutTime,
        SessionDuration::Enum sessionDuration,
        SequenceNumberResetPolicy::Enum seqNumberResetPolicy);

    SessionSchedule(const SessionSchedule & other);

    TimeOfDay logonTime(DayOfWeek::Enum day) const;

    void logonTime(DayOfWeek::Enum day, TimeOfDay time);

    TimeOfDay logoutTime(DayOfWeek::Enum day) const;

    void logoutTime(DayOfWeek::Enum day, TimeOfDay time);

    SessionDuration::Enum sessionDuration() const;

    SequenceNumberResetPolicy::Enum sequenceNumberResetPolicy() const;

    DayOfWeek::Enum sequenceNumberWeeklyResetDay() const;

    SessionSchedule & operator = (const SessionSchedule & other);
 
    std::string toString() const;
 
private:
    friend class SessionStateChanger;
 
    TimeOfDayOfWeek logonTimes_;
    TimeOfDayOfWeek logoutTimes_;
 
    SessionDuration::Enum sessionDuration_;
    SequenceNumberResetPolicy::Enum seqNumberResetPolicy_;
 
    DayOfWeek::Enum startOfWeek_;
    DayOfWeek::Enum endOfWeek_;
};
 
inline
TimeOfDay
SessionSchedule::logonTime(DayOfWeek::Enum day) const
{
    return logonTimes_[day];
}
 
inline
void
SessionSchedule::logonTime(
    DayOfWeek::Enum day, TimeOfDay logonTime)
{
    logonTimes_[day] = logonTime;
}
 
inline
TimeOfDay
SessionSchedule::logoutTime(DayOfWeek::Enum day) const
{
    return logoutTimes_[day];
}
 
inline
void
SessionSchedule::logoutTime(
    DayOfWeek::Enum day, TimeOfDay logoutTime)
{
    logoutTimes_[day] = logoutTime;
}
 
inline
SessionDuration::Enum
SessionSchedule::sessionDuration() const
{
    return sessionDuration_;
}
 
inline
SequenceNumberResetPolicy::Enum
SessionSchedule::sequenceNumberResetPolicy() const
{
    return seqNumberResetPolicy_;
}
 
inline
DayOfWeek::Enum
SessionSchedule::sequenceNumberWeeklyResetDay() const
{
    return startOfWeek_;
}
}
}
}