MeVisLab/Standard/Sources/ML/MLBase/mlCurveData.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

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


#ifndef __mlCurveData_H
#define __mlCurveData_H


// ML includes
#include "mlBase.h"
#include "mlTreeNode.h"

// Local includes
#include "mlBaseInit.h"
#include "mlBaseList.h"


ML_START_NAMESPACE


// --- Type definitions

typedef std::vector<double> CurveSeries;



// ------------------------------------------------------------------
// Base object class CurveData

// ------------------------------------------------------------------
class MLBASEEXPORT CurveData : public Base
{
public:

  enum { ctyLine,              
         ctyArea,              
         ctyDeltaArea,         
         ctyLineDeltaArea,     
         ctyErrorBar           
       };


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

  CurveData ();
  CurveData (const CurveData &curveData);

  virtual ~CurveData () {}

  virtual CurveData &operator = (const CurveData &srcCurve);


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

  virtual void clearData ();
  virtual void clear ();

  virtual void setX (MLssize_t nPoints = 0, double *data = 0, MLssize_t step = 1);

  virtual void setY (MLssize_t nPoints, double *data, MLssize_t step = 1);

  virtual void setY (MLssize_t iSeries, MLssize_t nPoints, double *data, MLssize_t step = 1);

  virtual void setXValue (double value, MLssize_t iPoint);
  virtual void setYValue (double value, MLssize_t iSeries, MLssize_t iPoint);
  virtual void setYValue (double value, MLssize_t iPoint);

  virtual void resizeX(MLssize_t nPoints);
  virtual void resizeY(MLssize_t nPoints);
  virtual void resizeY(MLssize_t iSeries, MLssize_t nPoints);


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

  virtual MLssize_t getPoints ();
  virtual MLssize_t getNumSeries ();

  virtual double getXValue (MLssize_t iPoint);
  virtual double getYValue (MLssize_t iSeries, MLssize_t iPoint);
  virtual double getYValue (MLssize_t iPoint);


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

  virtual void setXRange (double xMin, double xMax);
  virtual void setAutoXRange ();
  virtual void setYRange (double yMin, double yMax);
  virtual void setAutoYRange ();

  virtual void setCurveType (int type);
  virtual void setCurveStyle (int style);

  virtual void setTitle (std::string title);
  virtual void setUnit (std::string unit);
  virtual void setSymbol (std::string symbol);


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

  bool isAutoX () { return _autoX; }

  virtual double getXMin ();
  virtual double getXMax ();
  virtual double getYMin ();
  virtual double getYMax ();
  virtual void getXYRange (double *xMin, double *xMax, double *yMin, double *yMax);

  virtual int getCurveType ();
  virtual int getCurveStyle ();

  virtual std::string getTitle ();
  virtual std::string getUnit ();
  virtual std::string getSymbol ();


  virtual void addStateToTree(TreeNode* /*parent*/) const;

  virtual void readStateFromTree(TreeNode* /*parent*/);

  // set current version number
  ML_SET_ADDSTATE_VERSION(1);

  virtual CurveData* deepCopy() const { return new CurveData(*this); };

protected:

  virtual void setXChanged ();
  virtual void setYChanged ();

  virtual void setSeries (CurveSeries &v, MLssize_t nPoints, double *data, MLssize_t step);

  virtual void updateData () {}

  virtual void updateAutoX ();
  virtual void updateXRange ();
  virtual void updateYRange ();

#ifdef ML_DEPRECATED



public:
  ML_DEPRECATED void setX (MLssize_t nPoints, float *data, MLssize_t step = 1);
  ML_DEPRECATED void setY (MLssize_t nPoints, float *data, MLssize_t step = 1);
  ML_DEPRECATED void setY (MLssize_t iSeries, MLssize_t nPoints, float *data, MLssize_t step = 1);
  ML_DEPRECATED void getXYRange (float *xMin, float *xMax, float *yMin, float *yMax);

protected:
  ML_DEPRECATED void setSeries (CurveSeries &v, MLssize_t nPoints, float *data, MLssize_t step);

#endif

protected:
  CurveSeries _xData;
  std::vector<CurveSeries> _yData;

  bool _autoX;
  
  bool _autoXRange;
  bool _autoYRange;
  
  bool _validXRange;
  bool _validYRange;

  double _xMin, _xMax, 
         _yMin, _yMax;
  
  int _curveType;
  int _curveStyle;

  std::string _title;
  std::string _unit;
  std::string _symbol;


  ML_CLASS_HEADER(CurveData)
};

ML_END_NAMESPACE

#endif
// __mlCurveData_H