DwmTimeInterval.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmTimeInterval.hh 8401 $
// @(#) $Id: DwmTimeInterval.hh 8401 2016-04-17 06:44:31Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2005-2007
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMTIMEINTERVAL_HH_
#define _DWMTIMEINTERVAL_HH_

extern "C" {
  #include <assert.h>
}

#include <utility>

#include "DwmTimeValue.hh"
#include "DwmReadable.hh"
#include "DwmWritable.hh"
#include "DwmGZReadable.hh"
#include "DwmGZWritable.hh"
#include "DwmBZ2Readable.hh"
#include "DwmBZ2Writable.hh"

namespace Dwm {

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class TimeInterval
    : public Readable, public Writable,
      public GZReadable, public GZWritable,
      public BZ2Readable, public BZ2Writable
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TimeInterval()
        : _data()
    {}
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TimeInterval(const TimeValue & start, const TimeValue & end)
        : _data(start, end)
    {
      assert(end >= start);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TimeInterval(const TimeInterval & timeInterval)
        : _data(timeInterval._data)
    {}

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue & Start() const
    {
      return(_data.first);
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue & Start(const TimeValue & start);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue & End() const
    {
      return(_data.second);
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TimeValue & End(const TimeValue & end);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const TimeInterval & ti) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TimeValue Duration() const
    {
      return (_data.second - _data.first);
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Contains(const TimeValue & tv) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Contains(const TimeInterval & ti) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Overlaps(const TimeInterval & ti) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Adjacent(const TimeInterval & ti) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t StreamedLength() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE *f);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE *f) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const;
    
  private:
    std::pair<TimeValue, TimeValue>  _data;
  };
  
}  // namespace Dwm

#endif  // _DWMTIMEINTERVAL_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------