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

Link Class. More...

#include <Link.h>

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

Public Types

enum  direction_t { outDirection, inDirection }
 
typedef boost::shared_ptr< LinksharedPointer
 
- 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

std::pair< Node::sharedPointer,
Node::sharedPointer > 
nodes ()
 
Node::sharedPointer from ()
 
Node::sharedPointer to ()
 
Link::direction_t directionRelativeToNode (Node::sharedPointer node)
 
- 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 ()
 
virtual void setRecord (PointRecord::sharedPointer record)
 
std::string userDescription ()
 
void setUserDescription (const std::string &description)
 

Protected Member Functions

 Link (const std::string &name, Node::sharedPointer startNode, Node::sharedPointer endNode)
 
- Protected Member Functions inherited from RTX::Element
 Element (const std::string &name)
 
void setType (element_t type)
 

Detailed Description

Link Class.

A Link is a purely topological construct. It has start and end Node references.


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