EPANET  3.0
EPANET Development Project
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
Pattern Class Referenceabstract

A set of multiplier factors associated with points in time. More...

#include <pattern.h>

Inheritance diagram for Pattern:
Element FixedPattern VariablePattern

Public Types

enum  PatternType { FIXED_PATTERN, VARIABLE_PATTERN }
 
- Public Types inherited from Element
enum  ElementType {
  NODE, LINK, PATTERN, CURVE,
  CONTROL
}
 

Public Member Functions

 Pattern (std::string name_, int type_)
 
void setTimeInterval (int t)
 
void addFactor (double f)
 
int timeInterval ()
 
int size ()
 
double factor (int i)
 
double currentFactor ()
 
virtual void init (int interval, int tstart)=0
 
virtual int nextTime (int t)=0
 
virtual void advance (int t)=0
 
- Public Member Functions inherited from Element
 Element (std::string name_)
 

Static Public Member Functions

static Patternfactory (int type_, std::string name_, MemPool *memPool)
 

Public Attributes

int type
 type of time pattern
 
- Public Attributes inherited from Element
std::string name
 element's ID name
 
int index
 index in array of elements
 

Protected Attributes

std::vector< double > factors
 sequence of multiplier factors
 
int currentIndex
 index of current pattern interval
 
int interval
 fixed time interval (sec)
 

Detailed Description

A set of multiplier factors associated with points in time.

Time patterns are multipliers used to adjust nodal demands, pump/valve settings, or water quality source inputs over time. Pattern is an abstract class from which the FixedPattern and VariablePattern classes are derived.


The documentation for this class was generated from the following files: