plotsample.h

//
// author Kazys Stepanas
//
// Copyright (c) CSIRO 2013
//
#ifndef __PLOTSAMPLE_H_
#define __PLOTSAMPLE_H_

#include "plotsconfig.h"

#include "plotexpression.h"

class PlotInstanceSampler;

class QTextStream;

struct PlotSampleId
{
  QString name; 
  char quote;   
  bool regex;   

  inline PlotSampleId(const QString &name = QString(), char quote = '\0', bool regex = false)
    : name(name), quote(quote), regex(regex) { fixQuote(); }

  inline PlotSampleId(const QString &name, bool regex)
    : name(name), quote('\0'), regex(regex) { fixQuote(); }

  inline PlotSampleId(const PlotSampleId &other)
    : name(other.name), quote(other.quote), regex(other.regex) { }

  inline operator bool() const { return !name.isEmpty(); }

  inline bool operator !() const { return name.isEmpty(); }

  inline void fixQuote()
  {
    if (!quote && regex)
    {
      quote = '\'';
    }
  }
};

QTextStream &operator << (QTextStream &stream, const PlotSampleId &sid);

class PlotSample : public PlotExpression
{
public:
  PlotSample(const QString &curveName, bool curveRegularExpression = false);

  PlotSample(const QString &curveName, const QString &fileName, bool curveRegularExpression = false, bool fileRegularExpression = false);

  PlotSample(const PlotSampleId &curveId, const PlotSampleId &fileId = PlotSampleId());

  PlotSample(const PlotSample &other);

  ~PlotSample();

  virtual double sample(double sampleTime) const;

  virtual BindResult bind(const QList<PlotInstance *> &curves, PlotBindingTracker &bindTracker,
                          PlotExpressionBindDomain &info, bool repeatLastBinding = false);

  virtual void unbind();

  virtual PlotExpression *clone() const;

private:
  virtual QString stringExpression() const;

  QString makeBoundName(const PlotInstance &plot) const;

  // Binding support.

  static bool nameMatch(const QString &name, const QString &searchName, const QRegExp *re = nullptr);

  PlotSampleId _curveId;    
  PlotSampleId _fileId;     
  QString _boundName; 
  PlotInstanceSampler *_sampler;  
  mutable unsigned int _previousSample; 
};

#endif // __PLOTSAMPLE_H_