$darkmode
Qore EmpathicBuildingDataProvider Module Reference 1.0
EmpathicBuildingDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
29
30public:
33
35 string uri_path = "/";
36
39
41 const ProviderInfo = <DataProviderInfo>{
42 "type": "EmpathicBuildingDataProvider",
43 "supports_children": True,
44 "constructor_options": ConstructorOptions,
45 "children_can_support_apis": True,
46 };
47
49 const ConstructorOptions = {
50 "restclient": <DataProviderOptionInfo>{
51 "type": AbstractDataProviderType::get(new Type("RestClient")),
52 "desc": "The RestClient object",
53 },
54 "url": <DataProviderOptionInfo>{
55 "type": AbstractDataProviderTypeMap."string",
56 "desc": "The URL to the REST server; overrides any URL in any RestClient object passed as an option",
57 "default_value": "https://eu-api.empathicbuilding.com",
58 },
59 "restclient_options": <DataProviderOptionInfo>{
60 "type": AbstractDataProviderTypeMap."*hash",
61 "desc": "Options to the RestClient constructor; only used if a RestClient object is created for a "
62 "call",
63 },
64 "token": <DataProviderOptionInfo>{
65 "type": AbstractDataProviderTypeMap."string",
66 "desc": "A gateway token to use for authentication to the server",
67 "sensitive": True,
68 },
69 };
70
71protected:
72 const ChildMap = {
73 "measurements": Class::forName("EmpathicBuildingDataProvider::EmpathicBuildingMeasurementsDataProvider"),
74 };
75
76public:
77
79 constructor(*hash<auto> options);
80
81
82 static RestClient::RestClient getRestConnection(*hash<auto> options);
83
85 string getName();
86
87
89 *string getDesc();
90
91
93 *list<hash<DataProvider::DataProviderSummaryInfo>> getChildProviderSummaryInfo();
94
95
97
99protected:
101public:
102
103
105
109protected:
111public:
112
113
115protected:
116 hash<DataProvider::DataProviderInfo> getStaticInfoImpl();
117public:
118
119};
120
123
125const SoftBoolDataProviderStringType = AbstractDataProviderType::get(SoftBoolStringType);
126
128class SoftBoolStringType : public Qore::Reflection::Type {
129
130public:
133
134
136 auto acceptsValue(auto value);
137
138
141
142};
143};
hash< DataProvider::DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
string display_name
The value to returns as the name of the object.
Definition: EmpathicBuildingDataProvider.qc.dox.h:38
*string getDesc()
Returns the data provider description.
*RestClient::RestClient rest
The REST client object for API calls.
Definition: EmpathicBuildingDataProvider.qc.dox.h:32
*DataProvider::AbstractDataProvider getChildProviderImpl(string name)
Returns the given child provider or NOTHING if the given child is unknown.
string getName()
Returns the data provider name.
*list< string > getChildProviderNamesImpl()
Returns a list of child data provider names, if any.
constructor(*hash< auto > options)
Creates the object from constructor options.
*list< hash< DataProvider::DataProviderSummaryInfo > > getChildProviderSummaryInfo()
Return data provider summary info.
Boolean string type.
Definition: EmpathicBuildingDataProvider.qc.dox.h:128
auto getDefaultValue()
Returns the default value for the type or NOTHING if the type has no default value.
auto acceptsValue(auto value)
Returns the value after any conversions by the type.
const True
Qore EmpathicBuildingDataProvider module definition.
Definition: EmpathicBuildingDataProvider.qc.dox.h:26
const SoftBoolDataProviderStringType
Boolean data provider string type for query parameters.
Definition: EmpathicBuildingDataProvider.qc.dox.h:125
const SoftBoolStringType
Boolean string type for query parameters.
Definition: EmpathicBuildingDataProvider.qc.dox.h:122