EPANET  3.0
EPANET Development Project
Public Member Functions | List of all members
VariablePattern Class Reference

A Pattern where factors change at varying time intervals. More...

#include <pattern.h>

Inheritance diagram for VariablePattern:
Pattern Element

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from Pattern
enum  PatternType { FIXED_PATTERN, VARIABLE_PATTERN }
 
- Public Types inherited from Element
enum  ElementType {
  NODE, LINK, PATTERN, CURVE,
  CONTROL
}
 
- Static Public Member Functions inherited from Pattern
static Patternfactory (int type_, std::string name_, MemPool *memPool)
 
- Public Attributes inherited from Pattern
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 inherited from Pattern
std::vector< double > factors
 sequence of multiplier factors
 
int currentIndex
 index of current pattern interval
 
int interval
 fixed time interval (sec)
 

Detailed Description

A Pattern where factors change at varying time intervals.

Note
When time exceeds the last time interval of a variable pattern the multiplier factor remains constant at its last value.

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