EPICS ARCHIVER V4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Member Functions | List of all members
RTree::Datablock Class Referenceabstract

Each RTree leaf points to Datablocks; they describe where the actual data that the index references resides via a filename and an offset into that file. More...

#include <RTree.h>

Public Member Functions

 Datablock ()
 Constructor.
 
virtual ~Datablock ()
 Destructor.
 
virtual bool isValid () const =0
 
const stdString & getDataFilename () const
 The file name referenced by this entry. More...
 
FileOffset getDataOffset () const
 The file offset of this entry. More...
 
virtual const IntervalgetInterval () const =0
 Returns interval.
 
virtual bool getNextChainedBlock ()=0
 Get a sub-block that's under the current block. More...
 
virtual bool getNextDatablock ()=0
 Get the data block for the next time interval from the RTree. More...
 
virtual bool getPrevDatablock ()=0
 Absolutely no clue what this one could do. More...
 

Detailed Description

Each RTree leaf points to Datablocks; they describe where the actual data that the index references resides via a filename and an offset into that file.

Member Function Documentation

const stdString& RTree::Datablock::getDataFilename ( ) const
inline

The file name referenced by this entry.

FileOffset RTree::Datablock::getDataOffset ( ) const
inline

The file offset of this entry.

virtual bool RTree::Datablock::getNextChainedBlock ( )
pure virtual

Get a sub-block that's under the current block.

A record might not only point to the 'main' data block,
the one originally inserted and commonly used
for data retrieval. It can also contain a chain of
data blocks that were inserted later (at a lower priority).
In case you care about those, invoke getNextChainedBlock()
until it returns false.

A possible usage scenario would be to

  1. Start with a valid data block.
  2. iterate over chained blocks until getNextChainedBlock() returns false
  3. then continue with getNextDatablock()

To allow for this, getNextChainedBlock() will leave the data block 'valid' when it reaches the last chained block.

@exception GenericException on read error, or when called
      while isValid() == false.
virtual bool RTree::Datablock::getNextDatablock ( )
pure virtual

Get the data block for the next time interval from the RTree.

Returns
true if one found. Otherwise, false is returned and isValid() will also indicate false.
See Also
getPrevDatablock
Exceptions
GenericExceptionon read error, or when called with isValid() == false.
virtual bool RTree::Datablock::getPrevDatablock ( )
pure virtual

Absolutely no clue what this one could do.

See Also
getNextDatablock
virtual bool RTree::Datablock::isValid ( ) const
pure virtual
Returns
true if this data block info is valid.

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