EPANET-RTX  1.1
real-time extension for the EPANET toolkit
Public Types | Public Member Functions | List of all members
RTX::Pipe Class Reference

Pipe Class. More...

#include <Pipe.h>

Inheritance diagram for RTX::Pipe:
[legend]
Collaboration diagram for RTX::Pipe:
[legend]

Public Types

enum  status_t { OPEN = true, CLOSED = false }
 
typedef boost::shared_ptr< PipesharedPointer
 
- Public Types inherited from RTX::Element
enum  element_t {
  JUNCTION, TANK, RESERVOIR, PIPE,
  PUMP, VALVE, DMA
}
 
typedef boost::shared_ptr
< Element
sharedPointer
 

Public Member Functions

 Pipe (const std::string &name, Node::sharedPointer startNode, Node::sharedPointer endNode)
 
virtual void setRecord (PointRecord::sharedPointer record)
 
double length ()
 
double diameter ()
 
void setLength (double length)
 
void setDiameter (double diameter)
 
status_t fixedStatus ()
 
void setFixedStatus (status_t status)
 
TimeSeries::sharedPointer flow ()
 
bool doesHaveStatusParameter ()
 
TimeSeries::sharedPointer statusParameter ()
 
void setStatusParameter (TimeSeries::sharedPointer status)
 
bool doesHaveSettingParameter ()
 
TimeSeries::sharedPointer settingParameter ()
 
void setSettingParameter (TimeSeries::sharedPointer setting)
 
bool doesHaveFlowMeasure ()
 
TimeSeries::sharedPointer flowMeasure ()
 
void setFlowMeasure (TimeSeries::sharedPointer flow)
 
- Public Member Functions inherited from RTX::Element
virtual std::ostream & toStream (std::ostream &stream)
 
element_t type ()
 
void setName (const std::string &newName)
 
std::string name ()
 
std::string userDescription ()
 
void setUserDescription (const std::string &description)
 

Additional Inherited Members

- Protected Member Functions inherited from RTX::Element
 Element (const std::string &name)
 
void setType (element_t type)
 

Detailed Description

Pipe Class.

A Pipe is a hydraulic element that can carry water from one place to another.


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