EPANET-RTX  1.1
real-time extension for the EPANET toolkit
Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
RTX::DbPointRecord Class Referenceabstract

A persistence layer for databases. More...

#include <DbPointRecord.h>

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

Classes

class  request_t
 
class  RtxDbConnectException
 
class  RtxDbRetrievalException
 

Public Types

typedef boost::shared_ptr
< DbPointRecord
sharedPointer
 
- Public Types inherited from RTX::BufferPointRecord
typedef boost::circular_buffer
< Point
PointBuffer_t
 
typedef std::pair
< PointBuffer_t,
boost::shared_ptr
< boost::signals2::mutex > > 
BufferMutexPair_t
 
typedef std::map< std::string,
BufferMutexPair_t > 
KeyedBufferMutexMap_t
 
typedef boost::shared_ptr
< BufferPointRecord
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

Point point (const string &id, time_t time)
 Get a Point with a specific name at a specific time. More...
 
Point pointBefore (const string &id, time_t time)
 
Point pointAfter (const string &id, time_t time)
 
std::vector< PointpointsInRange (const string &id, time_t startTime, time_t endTime)
 Get a vector of Points with a specific name within a specific time range. More...
 
void addPoint (const string &id, Point point)
 
void addPoints (const string &id, std::vector< Point > points)
 
void reset ()
 
void reset (const string &id)
 
virtual void invalidate (const string &identifier)
 
virtual void truncate ()=0
 
virtual std::vector< std::pair
< std::string, Units > > 
availableData ()
 
virtual void dbConnect () throw (RtxException)
 
virtual bool isConnected ()
 
virtual bool supportsBoundedQueries ()
 
void setSearchDistance (time_t time)
 
time_t searchDistance ()
 
- Public Member Functions inherited from RTX::BufferPointRecord
 BufferPointRecord (int defaultCapacity=100)
 
virtual std::string registerAndGetIdentifier (std::string recordName, Units dataUnits)
 
virtual std::vector< std::string > identifiers ()
 
virtual Point firstPoint (const string &id)
 
virtual Point lastPoint (const string &id)
 
virtual time_pair_t range (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)
 

Public Attributes

std::string errorMessage
 

Protected Member Functions

virtual std::vector< PointselectRange (const std::string &id, time_t startTime, time_t endTime)=0
 
virtual Point selectNext (const std::string &id, time_t time)=0
 
virtual Point selectPrevious (const std::string &id, time_t time)=0
 
virtual void insertSingle (const std::string &id, Point point)=0
 
virtual void insertRange (const std::string &id, std::vector< Point > points)=0
 
virtual void removeRecord (const std::string &id)=0
 

Protected Attributes

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

Detailed Description

A persistence layer for databases.

Base class for database-connected PointRecord classes.

Member Function Documentation

Point DbPointRecord::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::BufferPointRecord.

std::vector< Point > DbPointRecord::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::BufferPointRecord.


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