EPANET-RTX  1.1
real-time extension for the EPANET toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
RTX::MapPointRecord Class Reference
Inheritance diagram for RTX::MapPointRecord:
[legend]
Collaboration diagram for RTX::MapPointRecord:
[legend]

Public Types

typedef boost::shared_ptr
< MapPointRecord
sharedPointer
 
- Public Types inherited from RTX::PointRecord
typedef boost::shared_ptr
< PointRecord
sharedPointer
 
typedef std::pair< time_t, time_t > time_pair_t
 

Public Member Functions

virtual std::string registerAndGetIdentifier (std::string recordName, Units dataUnits)
 
virtual std::vector< std::string > identifiers ()
 
virtual Point point (const string &identifier, time_t time)
 Get a Point with a specific name at a specific time. More...
 
virtual Point pointBefore (const string &identifier, time_t time)
 
virtual Point pointAfter (const string &identifier, time_t time)
 
virtual std::vector< PointpointsInRange (const string &identifier, time_t startTime, time_t endTime)
 Get a vector of Points with a specific name within a specific time range. More...
 
virtual void addPoint (const string &identifier, Point point)
 
virtual void addPoints (const string &identifier, std::vector< Point > points)
 
virtual void reset ()
 
virtual void reset (const string &identifier)
 
virtual Point firstPoint (const string &id)
 
virtual Point lastPoint (const string &id)
 
virtual std::ostream & toStream (std::ostream &stream)
 
- Public Member Functions inherited from RTX::PointRecord
std::string name ()
 
void setName (std::string name)
 
virtual void invalidate (const string &identifier)
 
virtual time_pair_t range (const string &id)
 

Protected Types

typedef std::map< time_t, PointpointMap_t
 
typedef std::map< int, pointMap_t > keyedPointMap_t
 

Protected Member Functions

int identifierForName (std::string recordName)
 
string nameForIdentifier (int identifier)
 

Additional Inherited Members

- Protected Attributes inherited from RTX::PointRecord
std::string _cachedPointId
 
Point _cachedPoint
 
std::map< std::string, Point_pointCache
 

Member Function Documentation

Point MapPointRecord::point ( const string &  identifier,
time_t  time 
)
virtual

Get a Point with a specific name at a specific time.

Parameters
nameThe name of the data source (tag name).
timeThe requested time.
Returns
The requested Point (as a shared pointer).
See also
Point

Reimplemented from RTX::PointRecord.

std::vector< Point > MapPointRecord::pointsInRange ( const string &  identifier,
time_t  startTime,
time_t  endTime 
)
virtual

Get a vector of Points with a specific name within a specific time range.

Parameters
nameThe name of the data source (tag name).
startTimeThe beginning of the requested time range.
endTimeThe end of the requested time range.
Returns
The requested Points (as a vector of shared pointers)
See also
Point

Reimplemented from RTX::PointRecord.


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