Documentation of UrbanFireXDT
Documentation of UrbanFireXDT
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
HPProfileIDCache Class Reference

#include <cache_helper.hpp>

Public Member Functions

 HPProfileIDCache (HPProfileIDCache const &)=delete
 
void operator= (HPProfileIDCache const &)=delete
 
void setCacheFilename (const std::string &filename)
 
void updateCache (size_t unitID, size_t profileID)
 
std::optional< size_t > readCache (size_t unitID)
 
void saveCacheFile ()
 

Static Public Member Functions

static HPProfileIDCacheGetInstance ()
 

Detailed Description

This is the singelton class for storing and querying the cache file for the heat pump profiles allocated to a given building referenced by the unitID.

Constructor & Destructor Documentation

◆ HPProfileIDCache()

HPProfileIDCache::HPProfileIDCache ( HPProfileIDCache const &  )
delete

Member Function Documentation

◆ GetInstance()

static HPProfileIDCache & HPProfileIDCache::GetInstance ( )
inlinestatic

Static method for getting the only instance of the singleton class

◆ operator=()

void HPProfileIDCache::operator= ( HPProfileIDCache const &  )
delete

◆ readCache()

std::optional< size_t > HPProfileIDCache::readCache ( size_t  unitID)
inline

Read an entry. Returns std::nullopt if not found

◆ saveCacheFile()

void HPProfileIDCache::saveCacheFile ( )
inline

Saves the current content of the cache file.

◆ setCacheFilename()

void HPProfileIDCache::setCacheFilename ( const std::string &  filename)
inline

Set the filename for the cache file

◆ updateCache()

void HPProfileIDCache::updateCache ( size_t  unitID,
size_t  profileID 
)
inline

Update or insert an entry


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