iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder Class Reference

#include <ApiDataLoggerQueryParamsBuilder.hpp>

Inheritance diagram for iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder:

Collaboration diagram for iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder:

Classes
struct	Request

Public Member Functions
	ApiDataLoggerQueryParamsBuilder ()=default
std::optional< std::string >	getChannelId () const override
std::unordered_map< std::string_view, std::string >	build () const override
ApiDataLoggerQueryParamsBuilder &	setChannelId (iv::types::channelId channelId)
ApiDataLoggerQueryParamsBuilder &	setStartTimestamp (iv::types::timestamp startTimestamp)
ApiDataLoggerQueryParamsBuilder &	setEndTimestamp (iv::types::timestamp endTimestamp)

Static Protected Member Functions
static std::string	parseStringList (const std::set< std::string > &stringValues)
	Parse a set of string values into a single string.

Private Attributes
std::optional< iv::types::channelId >	m_channelId
std::optional< iv::types::timestamp >	m_startTimestamp
std::optional< iv::types::timestamp >	m_endTimestamp

Constructor & Destructor Documentation

ApiDataLoggerQueryParamsBuilder()

iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::ApiDataLoggerQueryParamsBuilder ( )

default

Member Function Documentation

build()

std::unordered_map< std::string_view, std::string > iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::build ( ) const

nodiscardoverridevirtual

Implements iv::comms::api::IApiQueryParamsBuilder.

getChannelId()

std::optional< std::string > iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::getChannelId ( ) const

nodiscardoverridevirtual

Implements iv::comms::api::IApiQueryParamsBuilder.

parseStringList()

static std::string iv::comms::api::IApiQueryParamsBuilder::parseStringList ( const std::set< std::string > & stringValues )

inlinestaticprotectedinherited

Parse a set of string values into a single string.

Parameters

stringValues

Set of string values.

Returns

Parsed string with values separated by commas.

setChannelId()

ApiDataLoggerQueryParamsBuilder & iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::setChannelId

(

iv::types::channelId

channelId

)

setEndTimestamp()

ApiDataLoggerQueryParamsBuilder & iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::setEndTimestamp

(

iv::types::timestamp

endTimestamp

)

setStartTimestamp()

ApiDataLoggerQueryParamsBuilder & iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::setStartTimestamp

(

iv::types::timestamp

startTimestamp

)

Member Data Documentation

m_channelId

std::optional<iv::types::channelId> iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::m_channelId

private

m_endTimestamp

std::optional<iv::types::timestamp> iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::m_endTimestamp

private

m_startTimestamp

std::optional<iv::types::timestamp> iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder::m_startTimestamp

private

---

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

• src/comms/apis/dataLogger/ApiDataLoggerQueryParamsBuilder.hpp
• src/comms/apis/dataLogger/ApiDataLoggerQueryParamsBuilder.cpp