/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkTemporalRegion_h
#define __itkTemporalRegion_h

#include "itkRegion.h"
#include "itkRealTimeStamp.h"
#include "itkRealTimeInterval.h"
#include "itkNumericTraits.h"
#include <climits>

/** Define representations of infinite duration for frames and real time */
#define ITK_INFINITE_FRAME_DURATION itk::NumericTraits<itk::SizeValueType>::max()
#define ITK_INFINITE_REAL_DURATION RealTimeInterval(ITK_INFINITE_FRAME_DURATION, 0)

namespace itk
{
/** \class TemporalRegion
 * \brief Region subclass that holds a region in time
 *
 * A temporal region is represented using a starting point and a duration. Here
 * time can be measured both in frame numbers or real time (or both).
 *
 * \ingroup ITKVideoCore
 */
class TemporalRegion : public Region
{
public:

  /** Standard class typedefs */
  typedef TemporalRegion       Self;
  typedef Region               Superclass;

  itkTypeMacro(TemporalRegion, Region);

  /** Typedef for frame offsets */
  typedef ::itk::SizeValueType FrameOffsetType;

  /** Get/Set RealStart */
  void SetRealStart(const RealTimeStamp s);
  RealTimeStamp GetRealStart() const;

  /** Get/Set RealDuration */
  void SetRealDuration(const RealTimeInterval d);
  RealTimeInterval GetRealDuration() const;

  /** Get/Set FrameStart */
  void SetFrameStart(const FrameOffsetType s);
  FrameOffsetType GetFrameStart() const;

  /** Get/Set FrameDuration */
  void SetFrameDuration(const FrameOffsetType d);
  FrameOffsetType GetFrameDuration() const;

  /** Return RegionType (SRUCTURED_REGION) */
  virtual RegionType GetRegionType() const ITK_OVERRIDE;

  /** Constructor */
  TemporalRegion();

  /** Destructor */
  virtual ~TemporalRegion();

  /** Compare two temporal regions in Frame space */
  virtual bool IsEqualInFrames(const Self & region) const;

  /** Compare two temporal regions in Frame space */
  bool IsEqualInRealTime(const Self & region) const;

  /** Compare two temporal regions. (Both Frame and RealTime) */
  bool operator==(const Self & region) const;

  bool operator!=(const Self & region) const;

protected:

  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  /** Time boundaries */
  RealTimeStamp    m_RealStart;
  RealTimeInterval m_RealDuration;
  FrameOffsetType  m_FrameStart;
  FrameOffsetType  m_FrameDuration;

};  // end class TemporalRegion

/** ostream operator */
std::ostream & operator<<(std::ostream & os, const TemporalRegion & region);

} // end namespace itk

#endif
