iv::comms::api::IApiQueryParamsBuilder Class Reference

#include <IApiQueryParamsBuilder.hpp>

Inheritance diagram for iv::comms::api::IApiQueryParamsBuilder:

Public Member Functions
virtual	~IApiQueryParamsBuilder ()=default
virtual std::optional< std::string >	getChannelId () const =0
virtual std::unordered_map< std::string_view, std::string >	build () const =0

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

Constructor & Destructor Documentation

~IApiQueryParamsBuilder()

virtual iv::comms::api::IApiQueryParamsBuilder::~IApiQueryParamsBuilder ( )

virtualdefault

Member Function Documentation

build()

virtual std::unordered_map< std::string_view, std::string > iv::comms::api::IApiQueryParamsBuilder::build ( ) const

nodiscardpure virtual

Implemented in iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder, iv::comms::api::historyLogger::ApiHistoryLoggerQueryParamsBuilder, and iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder.

getChannelId()

virtual std::optional< std::string > iv::comms::api::IApiQueryParamsBuilder::getChannelId ( ) const

nodiscardpure virtual

Implemented in iv::comms::api::dataLogger::ApiDataLoggerQueryParamsBuilder, iv::comms::api::historyLogger::ApiHistoryLoggerQueryParamsBuilder, and iv::comms::apis::eventLogger::ApiEventLoggerQueryParamsBuilder.

parseStringList()

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

inlinestaticprotected

Parse a set of string values into a single string.

Parameters

stringValues

Set of string values.

Returns

Parsed string with values separated by commas.

---

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

• src/comms/apis/IApiQueryParamsBuilder.hpp