roo_monitoring
API Documentation for roo_monitoring
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
roo_monitoring::VaultFileRef Class Reference

Identifies a specific file in the monitoring vault. More...

#include <vault.h>

Public Member Functions

 VaultFileRef ()
 
 VaultFileRef (const VaultFileRef &other)=default
 
VaultFileRef & operator= (const VaultFileRef &other)=default
 
int64_t timestamp () const
 Returns the start timestamp for this vault file.
 
int64_t timestamp_at (int position) const
 Returns the timestamp for the entry at the given position.
 
Resolution resolution () const
 Returns the resolution for this vault file.
 
int64_t time_step () const
 Returns the time step between entries.
 
int64_t time_steps (int count) const
 Returns the time step delta for the specified count.
 
int64_t time_span () const
 Returns the total time span covered by the file.
 
VaultFileRef parent () const
 Returns the parent vault file at the next coarser resolution.
 
VaultFileRef child (int index) const
 Returns the child vault file at the next finer resolution.
 
VaultFileRef prev () const
 Returns the previous vault file at the same resolution.
 
VaultFileRef next () const
 Returns the next vault file at the same resolution.
 
VaultFileRef advance (int n) const
 Returns the vault file advanced by n spans.
 
int sibling_index () const
 Returns the index of this file within its parent range.
 

Static Public Member Functions

static VaultFileRef Lookup (int64_t timestamp, Resolution resolution)
 Creates a reference that encloses the timestamp at the given resolution.
 

Detailed Description

Identifies a specific file in the monitoring vault.

Definition at line 16 of file vault.h.

Constructor & Destructor Documentation

◆ VaultFileRef() [1/2]

roo_monitoring::VaultFileRef::VaultFileRef ( )
inline

Definition at line 21 of file vault.h.

Referenced by advance(), child(), Lookup(), next(), and prev().

◆ VaultFileRef() [2/2]

roo_monitoring::VaultFileRef::VaultFileRef ( const VaultFileRef &  other)
default

Member Function Documentation

◆ advance()

VaultFileRef roo_monitoring::VaultFileRef::advance ( int  n) const
inline

Returns the vault file advanced by n spans.

Definition at line 66 of file vault.h.

References time_span(), timestamp(), and VaultFileRef().

Referenced by child().

◆ child()

VaultFileRef roo_monitoring::VaultFileRef::child ( int  index) const
inline

Returns the child vault file at the next finer resolution.

Definition at line 51 of file vault.h.

References advance(), and VaultFileRef().

◆ Lookup()

VaultFileRef roo_monitoring::VaultFileRef::Lookup ( int64_t  timestamp,
Resolution  resolution 
)
static

Creates a reference that encloses the timestamp at the given resolution.

Definition at line 414 of file monitoring.cpp.

References roo_monitoring::kRangeLength, resolution(), timestamp(), roo_monitoring::timestamp_ms_floor(), and VaultFileRef().

Referenced by roo_monitoring::Writer::flushSome(), and parent().

◆ next()

VaultFileRef roo_monitoring::VaultFileRef::next ( ) const
inline

Returns the next vault file at the same resolution.

Definition at line 61 of file vault.h.

References time_span(), and VaultFileRef().

Referenced by roo_monitoring::VaultIterator::next().

◆ operator=()

VaultFileRef & roo_monitoring::VaultFileRef::operator= ( const VaultFileRef &  other)
default

◆ parent()

VaultFileRef roo_monitoring::VaultFileRef::parent ( ) const
inline

Returns the parent vault file at the next coarser resolution.

Definition at line 46 of file vault.h.

References Lookup().

◆ prev()

VaultFileRef roo_monitoring::VaultFileRef::prev ( ) const
inline

Returns the previous vault file at the same resolution.

Definition at line 56 of file vault.h.

References time_span(), and VaultFileRef().

◆ resolution()

Resolution roo_monitoring::VaultFileRef::resolution ( ) const
inline

Returns the resolution for this vault file.

Definition at line 32 of file vault.h.

Referenced by roo_monitoring::Writer::flushSome(), roo_monitoring::Collection::getVaultFilePath(), Lookup(), roo_monitoring::VaultFileReader::next(), roo_monitoring::operator<<(), and roo_monitoring::VaultFileReader::seekForward().

◆ sibling_index()

int roo_monitoring::VaultFileRef::sibling_index ( ) const
inline

Returns the index of this file within its parent range.

Definition at line 71 of file vault.h.

References roo_monitoring::kRangeLength.

◆ time_span()

int64_t roo_monitoring::VaultFileRef::time_span ( ) const
inline

Returns the total time span covered by the file.

Definition at line 41 of file vault.h.

References roo_monitoring::kRangeLength.

Referenced by advance(), next(), roo_monitoring::operator<<(), and prev().

◆ time_step()

int64_t roo_monitoring::VaultFileRef::time_step ( ) const
inline

Returns the time step between entries.

Definition at line 35 of file vault.h.

Referenced by roo_monitoring::operator<<().

◆ time_steps()

int64_t roo_monitoring::VaultFileRef::time_steps ( int  count) const
inline

Returns the time step delta for the specified count.

Definition at line 37 of file vault.h.

References timestamp().

Referenced by timestamp_at().

◆ timestamp()

int64_t roo_monitoring::VaultFileRef::timestamp ( ) const
inline

Returns the start timestamp for this vault file.

Definition at line 26 of file vault.h.

Referenced by advance(), roo_monitoring::Collection::getVaultFilePath(), Lookup(), roo_monitoring::VaultIterator::next(), roo_monitoring::operator<<(), roo_monitoring::VaultFileReader::seekForward(), roo_monitoring::VaultFileReader::tell(), and time_steps().

◆ timestamp_at()

int64_t roo_monitoring::VaultFileRef::timestamp_at ( int  position) const
inline

Returns the timestamp for the entry at the given position.

Definition at line 28 of file vault.h.

References time_steps().

Referenced by roo_monitoring::VaultIterator::cursor().

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