iv::alarms::History Class Reference

#include <History.hpp>

Collaboration diagram for iv::alarms::History:

Public Member Functions
	History ()
	History (const History &other)=delete
	~History ()=default
void	addEvent (const iv::alarms::Event &newEvent) const
std::optional< std::vector< Event > >	getEvents (uint32_t pageRequested)
std::optional< iv::alarms::Event >	lastEvent (const std::optional< iv::types::channelId > &tag)
std::optional< std::vector< Event > >	getAllEvents (bool applyFilters=true) const

Static Public Member Functions
static std::optional< std::vector< iv::alarms::Event > >	getEventsFromHistoryLogger (const iv::comms::api::IApiQueryParamsBuilder &queryParams, iv::comms::api::ApiPaginationInfo &paginationInfoOut)
static bool	canGetEvents ()

Public Attributes
FilterHistory	m_filterHistory

Static Public Attributes
static constexpr uint32_t	historyPaginationSize {30}

Private Member Functions
std::set< iv::types::channelId >	prvFilterChannelTags () const

Constructor & Destructor Documentation

History() [1/2]

iv::alarms::History::History ( )

default

History() [2/2]

iv::alarms::History::History ( const History & other )

delete

~History()

iv::alarms::History::~History ( )

default

Member Function Documentation

addEvent()

void iv::alarms::History::addEvent

(

const iv::alarms::Event &

newEvent

)

const

canGetEvents()

bool iv::alarms::History::canGetEvents ( )

static

getAllEvents()

std::optional< std::vector< Event > > iv::alarms::History::getAllEvents ( bool applyFilters = true ) const

nodiscard

getEvents()

std::optional< std::vector< Event > > iv::alarms::History::getEvents ( uint32_t pageRequested )

nodiscard

getEventsFromHistoryLogger()

std::optional< std::vector< iv::alarms::Event > > iv::alarms::History::getEventsFromHistoryLogger ( const iv::comms::api::IApiQueryParamsBuilder & queryParams, iv::comms::api::ApiPaginationInfo & paginationInfoOut )

static

lastEvent()

std::optional< iv::alarms::Event > iv::alarms::History::lastEvent ( const std::optional< iv::types::channelId > & tag )

nodiscard

prvFilterChannelTags()

std::set< iv::types::channelId > iv::alarms::History::prvFilterChannelTags ( ) const

nodiscardprivate

Member Data Documentation

historyPaginationSize

uint32_t iv::alarms::History::historyPaginationSize {30}

staticconstexpr

m_filterHistory

FilterHistory iv::alarms::History::m_filterHistory

---

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

• src/alarms/History.hpp
• src/alarms/History.cpp