NDEVR
API Documentation
DeviCounterSettings

INI-based settings for DeviCounter connection behavior, timing, and simulation mode. More...

Inheritance diagram for DeviCounterSettings:
[legend]
Collaboration diagram for DeviCounterSettings:
[legend]

Public Member Functions

 DeviCounterSettings ()
 Constructs settings and loads from INI file.
void getINI (INIFactory &factory) final override
 Serializes/deserializes settings to/from INI.
void setToDefaults ()
 Resets all settings to their default values.
Public Member Functions inherited from INIInterface
 INIInterface ()
 Constructs an INIInterface with no default INI file.
 INIInterface (const File &default_ini)
 Constructs an INIInterface with the specified default INI file.
virtual ~INIInterface ()
 Virtual destructor for safe polymorphic cleanup.
virtual void finishReadingINI (INIFactory &)
 Called after reading an INI file.
virtual void prepareForINI (INIFactory &)
 Called before reading or writing an INI file.
virtual bool readINIOptions ()
 Reads INI options from the default INI file.
virtual bool readINIOptions (File &ini_file)
 Reads INI options from the specified INI file.
virtual bool saveINIOptions (bool multithead=false)
 Saves INI options to the default INI file.
virtual bool saveINIOptions (File &ini_file, bool multithead=false)
 Saves INI options to the specified INI file.
void setDefaultINIFile (const File &file)
 Sets the default INI file path used for reading and writing options.
virtual void writeToLog (const StringView &title, LogPtr log, uint01 log_level=2U)
 Writes the current INI options to the specified log with a title.
virtual void writeToLog (LogPtr log, uint01 log_level=2U)
 Writes the current INI options to the specified log.

Public Attributes

bool auto_connect
 Whether to auto-connect on startup.
TimeSpan retry_connection_period
 How long to wait before retrying a failed connection.
TimeSpan timeout_period
 Timeout duration for connection attempts.
TimeSpan update_interval
 Interval between device polling updates.
bool use_simulator
 Whether to use the simulation backend.

Additional Inherited Members

Protected Attributes inherited from INIInterface
File m_default_ini
 The default file path used for reading and writing INI options.

Detailed Description

INI-based settings for DeviCounter connection behavior, timing, and simulation mode.


Definition at line 40 of file DeviCounterSettings.h.

Member Function Documentation

◆ getINI()

void DeviCounterSettings::getINI ( INIFactory & factory)
finaloverridevirtual

Serializes/deserializes settings to/from INI.

Parameters
[in]factoryThe INI factory for reading/writing.

Implements INIInterface.


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