PointSample.h

Go to the documentation of this file.

/**<!-------------------------------------------------------------------->
   @class  PointSample
   @author Travis Fischer (fisch0920@gmail.com)
   @author Matthew Jacobs (jacobs.mh@gmail.com)
   @date   Fall 2008
   
   @brief
      Represents the value of a generic function ({x,y} -> any) evaluated at a 
   particular 2D point
   <!-------------------------------------------------------------------->**/

#ifndef POINT_SAMPLE_H_
#define POINT_SAMPLE_H_

#include <common/math/Point.h>
#include <stats/Event.h>
#include <deque>

struct PointSample;

DECLARE_STL_TYPEDEF(std::vector<PointSample>, PointSampleList);
DECLARE_STL_TYPEDEF(std::deque<PointSample>,  PointSampleQueue);

struct PointSample {
   
   ///@name Public data
   //@{-----------------------------------------------------------------
   
   Point2 position;
   Event  value;
   
   
   //@}-----------------------------------------------------------------
   ///@name Constructors
   //@{-----------------------------------------------------------------
   
   inline PointSample(const Point2 &position_, const Event &value_)
      : position(position_), value(value_)
   { }
   
   inline PointSample(const Point2 &position_)
      : position(position_), value()
   { }
   
   inline PointSample(const real_t x, const real_t y, const Event &value_)
      : position(x, y), value(value_)
   { }
   
   inline PointSample(const real_t x, const real_t y)
      : position(x, y), value()
   { }
   
   inline PointSample()
      : value()
   { }
   
   
   //@}-----------------------------------------------------------------
};

#endif // POINT_SAMPLE_H_