Qore EmpathicBuildingDataProvider Module Reference 1.1
Loading...
Searching...
No Matches
EmpathicBuildingDataProvider::EmpathicBuildingDataProvider Class Reference

The EmpathicBuilding data provider class. More...

#include <EmpathicBuildingDataProvider.qc.dox.h>

Inheritance diagram for EmpathicBuildingDataProvider::EmpathicBuildingDataProvider:
[legend]

Public Member Functions

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (RestClient::RestClient rest, *Logger::LoggerInterface logger)
 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.
 

Public Attributes

const ConstructorOptions = ...
 Constructor options.
 
string display_name
 The value to returns as the name of the object.
 
const ProviderInfo = ...
 Provider info.
 
string uri_path = "/"
 current URI path
 
- Public Attributes inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
const MaxIoRetries = 5
 Max retries.
 
const RetrySet = ...
 IO errors for REST retries.
 

Protected Member Functions

*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.
 
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.
 

Additional Inherited Members

- 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.
 
- Protected Attributes inherited from EmpathicBuildingDataProvider::EmpathicBuildingDataProviderBase
RestClient::RestClient rest
 The REST client object for API calls.
 

Detailed Description

The EmpathicBuilding data provider class.

Member Function Documentation

◆ getChildProviderImpl()

*DataProvider::AbstractDataProvider EmpathicBuildingDataProvider::EmpathicBuildingDataProvider::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::EmpathicBuildingDataProvider::getChildProviderNamesImpl ( )
protected

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

Returns
a list of child data provider names, if any