OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
openstudio::FloodPlotData Class Referenceabstract

#include <FloodPlot.hpp>

+ Inheritance diagram for openstudio::FloodPlotData:

Public Types

typedef std::shared_ptr< const
FloodPlotData
ConstPtr
 
typedef std::vector< ConstPtrConstVec
 
typedef std::weak_ptr< const
FloodPlotData
ConstWeakPtr
 
typedef std::shared_ptr
< FloodPlotData
Ptr
 
typedef std::vector< PtrVec
 
typedef std::weak_ptr
< FloodPlotData
WeakPtr
 

Public Member Functions

virtual void colorMapRange (QwtDoubleInterval colorMapRange)=0
 
virtual QwtDoubleInterval colorMapRange ()=0
 color map range More...
 
virtual FloodPlotDatacopy () const =0
 must provide copy More...
 
virtual double maxValue () const =0
 maxValue getter More...
 
virtual void maxValue (double max)=0
 maxValue setter More...
 
virtual double maxX () const =0
 maxX More...
 
virtual double maxY () const =0
 maxY More...
 
virtual double meanValue () const =0
 meanValue More...
 
virtual double minValue () const =0
 minValue getter More...
 
virtual void minValue (double min)=0
 minValue setter More...
 
virtual double minX () const =0
 minX More...
 
virtual double minY () const =0
 minY More...
 
QwtDoubleInterval range () const =0
 must provide range of values - colormap range not data range More...
 
virtual double stdDevValue () const =0
 stdDevValue More...
 
virtual double sumValue () const =0
 sumValue More...
 
virtual std::string units () const =0
 units for plotting on axes or scaling More...
 
virtual double value (double x, double y) const =0
 get the value at point x, y More...
 
virtual ~FloodPlotData ()
 virtual destructor More...
 

Protected Member Functions

 FloodPlotData ()
 

Detailed Description

FloodPlotData is abstract class for data that can be used in a flood plot.

Derive from this class to plot your data.

Member Typedef Documentation

typedef std::shared_ptr<const FloodPlotData > openstudio::FloodPlotData::ConstPtr
typedef std::shared_ptr< FloodPlotData > openstudio::FloodPlotData::Ptr
typedef std::vector<Ptr> openstudio::FloodPlotData::Vec

Constructor & Destructor Documentation

virtual openstudio::FloodPlotData::~FloodPlotData ( )
inlinevirtual

virtual destructor

openstudio::FloodPlotData::FloodPlotData ( )
inlineprotected

Member Function Documentation

virtual void openstudio::FloodPlotData::colorMapRange ( QwtDoubleInterval  colorMapRange)
pure virtual
virtual QwtDoubleInterval openstudio::FloodPlotData::colorMapRange ( )
pure virtual
virtual FloodPlotData* openstudio::FloodPlotData::copy ( ) const
pure virtual
virtual double openstudio::FloodPlotData::maxValue ( ) const
pure virtual
virtual void openstudio::FloodPlotData::maxValue ( double  max)
pure virtual
virtual double openstudio::FloodPlotData::maxX ( ) const
pure virtual
virtual double openstudio::FloodPlotData::maxY ( ) const
pure virtual
virtual double openstudio::FloodPlotData::meanValue ( ) const
pure virtual
virtual double openstudio::FloodPlotData::minValue ( ) const
pure virtual
virtual void openstudio::FloodPlotData::minValue ( double  min)
pure virtual
virtual double openstudio::FloodPlotData::minX ( ) const
pure virtual
virtual double openstudio::FloodPlotData::minY ( ) const
pure virtual
QwtDoubleInterval openstudio::FloodPlotData::range ( ) const
pure virtual

must provide range of values - colormap range not data range

Implemented in openstudio::MatrixFloodPlotData, and openstudio::TimeSeriesFloodPlotData.

virtual double openstudio::FloodPlotData::stdDevValue ( ) const
pure virtual
virtual double openstudio::FloodPlotData::sumValue ( ) const
pure virtual
virtual std::string openstudio::FloodPlotData::units ( ) const
pure virtual

units for plotting on axes or scaling

Implemented in openstudio::MatrixFloodPlotData, and openstudio::TimeSeriesFloodPlotData.

virtual double openstudio::FloodPlotData::value ( double  x,
double  y 
) const
pure virtual

get the value at point x, y

Implemented in openstudio::MatrixFloodPlotData, and openstudio::TimeSeriesFloodPlotData.