TimeRange.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk 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 3.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef TIMERANGE_HPP
#define TIMERANGE_HPP
 
#include <map>
#include <string>
 
#include "CommonTime.hpp"
#include "Exception.hpp"
#include "StringUtils.hpp"
 
 
namespace gnsstk
{
 
 
   class TimeRange
   {
   public:
 
      NEW_EXCEPTION_CLASS(TimeRangeException, Exception);
 
      typedef std::pair<CommonTime, CommonTime> DTPair;
 
      TimeRange();
 
      TimeRange(const CommonTime& startDT,
                const CommonTime& endDT,
                const bool startInclusive=true,
                const bool endInclusive=true);
 
      TimeRange(DTPair dtPair,
                const bool startInclusive=true,
                const bool endInclusive=true);
 
      TimeRange(const TimeRange& tr);
 
      ~TimeRange( ) {};
 
         // Accessors
      CommonTime getStart() const { return start; }
      CommonTime getEnd() const { return end; }
 
      void set( const CommonTime& startDT,
                const CommonTime& endDT,
                const bool startInclusive=true,
                const bool endInclusive=true );
 
      bool inRange( const CommonTime& testDT ) const;
 
      bool operator==(const TimeRange& right) const;
 
      bool operator<(const TimeRange& right) const;
 
      bool isPriorTo( const TimeRange& right ) const;
 
      bool overlaps( const TimeRange& right ) const;
 
      bool isSubsetOf( const TimeRange& right ) const;
 
      bool isAfter( const TimeRange& right ) const;
 
      TimeRange& setToString( const std::string& str,
                              const std::string& fmt);
 
      std::string printf(const std::string formatArg="%02m/%02d/%02y %02H:%02M:%02S" ) const;
 
      std::string dump(const std::string formatArg="%02m/%02d/%02y %02H:%02M:%02S" ) const;
 
   protected:
      CommonTime start;
      CommonTime end;
      bool includeStartTime;
      bool includeEndTime;
 
      void init(const CommonTime& startDT,
                const CommonTime& endDT,
                const bool startInclusive=true,
                const bool endInclusive=true);
 
   };
 
 
}   // end namespace
 
#endif