EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider Class Reference

The EmpathicBuilding sensor data provider class. More...

#include <EmpathicBuildingSensorDataProvider.qc.dox.h>

Inheritance diagram for EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider:

Public Member Functions
	constructor (RestClient::RestClient rest, *Logger::LoggerInterface logger, hash< auto > org, hash< auto > loc, hash< auto > sensor)
	Create the object from the REST connection.
*list< hash< DataProvider::DataProviderSummaryInfo > >	getChildProviderSummaryInfo ()
	Return data provider summary info.
*string	getDesc ()
	Returns the data provider description.
string	getName ()
	Returns the data provider name.
Public Member Functions inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
	constructor ()
	Creates the object.
	constructor (RestClient::RestClient rest, *Logger::LoggerInterface logger)
	Creates the object.
	setLogger (*LoggerInterface logger)
	Accepts a LoggerInterface object for logging (or clears it)
	updateConnectionObjects (object conn, object connobj)
	Update any connection used by the data provider.

Static Public Member Functions
static hash< auto >	getSensorData (hash< auto > sensor)
	Converts ms epoch offsets to date/time values.
static string	getSensorDesc (hash< auto > sensor)
	Returns a description of the sensor.
Static Public Member Functions inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
static date	getTimestamp (int epoch_ms)
	Converts a Haltian ms epoch offset to a date/time value.

Public Attributes
const	ProviderInfo = ...
	Provider info.
const	ProviderSummaryInfo = ...
	Provider summary info.
const	RequestType = AbstractDataProviderTypeMap."nothing"
	Request type.
const	ResponseType = EmpathicBuildingSensorType
	Response type.
Public Attributes inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
const	MaxIoRetries = 5
	Max retries.
const	RetrySet = ...
	IO errors for REST retries.

Protected Member Functions
auto	doRequestImpl (auto req, *hash< auto > request_options)
	Makes a request and returns the response.
*DataProvider::AbstractDataProvider	getChildProviderImpl (string name)
	Returns the given child provider or NOTHING if the given child is unknown.
*list< string >	getChildProviderNamesImpl ()
	Returns a list of child data provider names, if any.
*DataProvider::AbstractDataProviderType	getRequestTypeImpl ()
	Returns the description of a successful request message, if any.
*DataProvider::AbstractDataProviderType	getResponseTypeImpl ()
	Returns the description of a response message, if this object represents a response message.
hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.
Protected Member Functions inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
hash< auto >	doRestCommand (string method, string path, auto body, reference< hash< auto > > info)
	Makes a REST call and returns the response.
bool	retry (hash< ExceptionInfo > ex, reference< int > retries)
	Returns True if the error indicates that the operation should be retried.

Protected Attributes
hash< auto >	loc
	Loc data.
hash< auto >	org
	Org data.
hash< auto >	sensor
	Sensor data.
Protected Attributes inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
RestClient::RestClient	rest
	The REST client object for API calls.

Detailed Description

The EmpathicBuilding sensor data provider class.

Member Function Documentation

doRequestImpl()

auto EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider::doRequestImpl ( auto req, *hash< auto > request_options )

protected

Makes a request and returns the response.

Parameters

req	the request to serialize and make according to the request type
request_options	the request options; will be processed by validateRequestOptions()

Returns

the response to the request

getChildProviderImpl()

*DataProvider::AbstractDataProvider EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider::getChildProviderImpl ( string name )

protected

Returns the given child provider or NOTHING if the given child is unknown.

Returns

the given child provider or NOTHING if the given child is unknown

See also

getChildProviderEx()

getChildProviderNamesImpl()

*list< string > EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider::getChildProviderNamesImpl ( )

protected

Returns a list of child data provider names, if any.

Returns

a list of child data provider names, if any

getRequestTypeImpl()

*DataProvider::AbstractDataProviderType EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider::getRequestTypeImpl ( )

protected

Returns the description of a successful request message, if any.

Returns

the request type for this provider

getResponseTypeImpl()

*DataProvider::AbstractDataProviderType EmpathicBuildingDataProvider::EmpathicBuildingSensorDataProvider::getResponseTypeImpl ( )

protected

Returns the description of a response message, if this object represents a response message.

Returns

the response type for this response message