pattern.h

Go to the documentation of this file.

/* EPANET 3
 *
 * Copyright (c) 2016 Open Water Analytics
 * Licensed under the terms of the MIT License (see the LICENSE file for details).
 *
 */


#ifndef PATTERN_H_
#define PATTERN_H_

#include "Elements/element.h"

#include <string>
#include <vector>

class MemPool;


class Pattern: public Element
{
  public:

    enum PatternType {FIXED_PATTERN, VARIABLE_PATTERN};

    // Constructor/Destructor
    Pattern(std::string name_, int type_);
    virtual ~Pattern();

    // Pattern factory
    static  Pattern* factory(int type_, std::string name_, MemPool* memPool);

    // Methods
    void           setTimeInterval(int t) { interval = t; }
    void           addFactor(double f) { factors.push_back(f); }
    int            timeInterval() { return interval; }
    int            size() { return factors.size(); }
    double         factor(int i) { return factors[i]; }
    double         currentFactor();
    virtual void   init(int interval, int tstart) = 0;
    virtual int    nextTime(int t) = 0;
    virtual void   advance(int t) = 0;

    // Properties
    int            type;                

  protected:
    std::vector<double> factors;        
    int                 currentIndex;   
    int                 interval;       
};

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


class FixedPattern : public Pattern
{
  public:

    // Constructor/Destructor
    FixedPattern(std::string name_);
    ~FixedPattern();

    // Methods
    void   init(int interval, int tstart);
    int    nextTime(int t);
    void   advance(int t);

  private:
    int    startTime;   
};

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


class VariablePattern : public Pattern
{
  public:

    // Constructor/Destructor
    VariablePattern(std::string name_);
    ~VariablePattern();

    // Methods
    void   addTime(int t) { times.push_back(t); }
    int    time(int i) { return times[i]; }
    void   init(int interval, int tstart);
    int    nextTime(int t);
    void   advance(int t);

  private:
    std::vector<int>   times;  
};

#endif