---

time.DateOperation.h

/*----------------------------------------------------------------------------
  SWORD 2000 - Software With Objects for Rapid Development
  Copyright (C) 2003 Eric NICOLAS
  ----------------------------------------------------------------------------
  SWORD is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  SWORD is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with SWORD; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  --------------------------------------------------------------------------*/
#ifndef _SWORD_TIME_DATEOPERATION_
#define _SWORD_TIME_DATEOPERATION_

#include "time.HolidayManager.h"

namespace sword {


  class SWORDDECL DateOperation {
  public:
          DateOperation();
    DateOperation(const std::string& description);
    ~DateOperation();

    // Business Day Conventions

    enum BDC { bdcNone, bdcModf, bdcNext, bdcPrev, bdcInvalid };
    // None    - Do nothing
    // Invalid - Indicates an invalid date operation
    // Modf    - "Modified-Following"
    //           If a target day is a holiday, skip to next
    //           business day, except if it would change
    //           month in which case skip to the previous
    //           business day
    // Next    - "Next business day"
    //           If a target day is a holiday, skip to the
    //           next business day
    // Prev    - "Previous business day"
    //           If a target day is a holiday, skip to the
    //           previous business day

    // Get information
    std::string toString() const;
    bool empty() const;
    bool emptyDelay() const;
    bool emptyBdc() const;
    bool valid() const;

    // Modify the operation
    void parse(const std::string& description);
    void clear();
    void neg();
    void invalidates();

    // Get
    int  days() const;
    bool workDays() const;
    int  months() const;
          bool monthEndToEnd() const;
          int  years() const;
          bool yearEndToEnd() const;
    BDC  bdc() const;
    PHolidayRepository holidays() const;

    // Set
    void days(int days);
    void workDays(bool workDays);
    void months(int months);
          void monthEndToEnd(bool endToEnd);
          void years(int years);
          void yearEndToEnd(bool endToEnd);
    void bdc(BDC bdc);
    void holidays(const std::string& holidaysName);
    void holidays(PHolidayRepository holidays);

    // Using the operation
    void   apply(Date& date, int times=1) const;
    void   applyDelay(Date& date, int times=1) const;
    void   applyBdc(Date& date) const;
    double fraction() const;

    // Simple atomic operations
    static void addWorkDays(Date& date, int days, const HolidayRepository& holidays);
    static void addWorkDayModified(Date& date, const HolidayRepository& holidays);

    // Syntax error in a date operation description
    class SyntaxException : public Exception {};

  private:
    int  years_;
    bool yearEndToEnd_;
    int  months_;
    bool monthEndToEnd_;
    int  days_;
    bool workDays_;

    BDC  bdc_;
    PHolidayRepository holidays_;
  };

} // namespace sword

#include "sword.private/time.DateOperation.inl"

#endif // _SWORD_TIME_DATEOPERATION_

---