NDEVR
API Documentation
DeviCounterSettings.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2023, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: DeviCounter
28File: DLLInfo
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/INIInterface.h>
34#include <NDEVR/TimeSpan.h>
35namespace NDEVR
36{
41 {
42 public:
49 void getINI(INIFactory& factory) final override;
50 public:
56 public:
57 static DeviCounterSettings& DefaultSettings();
58 };
59
60}
TimeSpan update_interval
Interval between device polling updates.
TimeSpan timeout_period
Timeout duration for connection attempts.
bool auto_connect
Whether to auto-connect on startup.
void getINI(INIFactory &factory) final override
Serializes/deserializes settings to/from INI.
TimeSpan retry_connection_period
How long to wait before retrying a failed connection.
bool use_simulator
Whether to use the simulation backend.
DeviCounterSettings()
Constructs settings and loads from INI file.
void setToDefaults()
Resets all settings to their default values.
Contains methods for easily reading and writing to an INI file including efficient casting,...
Definition INIReader.h:107
INIInterface()
Constructs an INIInterface with no default INI file.
Stores a time span, or difference between two times, with an optional start time.
Definition TimeSpan.h:46
The primary namespace for the NDEVR SDK.