util::supervise::SystemInfo Class Reference

Simple support class to known directories. More...

#include <systeminfo.h>

Public Member Functions
	SystemInfo ()=default
	Default constructor.
	SystemInfo (std::string program_name)
	Constructor with its program or system name.
void	ProgramName (std::string name)
	Sets the system or program name.
std::string	ProgramName () const
	Returns the program or system name.
std::string	DataPath () const
	Returns the default data path.
std::string	ConfigPath () const
	Returns the default configuration path.
std::string	CachePath () const
	Returns the default cache path.
std::string	StatePath () const
	Returns the default state path.
std::string	ProgramDataPath () const
	Returns the default program data path.

Detailed Description

Support class that is a wrapper around against system settings and known directories.

Constructor & Destructor Documentation

SystemInfo() [1/2]

util::supervise::SystemInfo::SystemInfo ( )

default

Use this constructor to get the operating system default directories.

SystemInfo() [2/2]

util::supervise::SystemInfo::SystemInfo ( std::string program_name )

explicit

This is the normal use. The program or system name defines where the system places its log and configuration files.

Parameters

program_name

Program or system name.

Member Function Documentation

CachePath()

std::string util::supervise::SystemInfo::CachePath ( ) const

nodiscard

Returns

Cache path.

ConfigPath()

std::string util::supervise::SystemInfo::ConfigPath ( ) const

nodiscard

Returns

Default configuration path.

DataPath()

std::string util::supervise::SystemInfo::DataPath ( ) const

nodiscard

Returns

Default data path.

ProgramDataPath()

std::string util::supervise::SystemInfo::ProgramDataPath ( ) const

nodiscard

Returns

Default state path.

ProgramName() [1/2]

std::string util::supervise::SystemInfo::ProgramName ( ) const

inlinenodiscard

Returns

Program or system name.

ProgramName() [2/2]

void util::supervise::SystemInfo::ProgramName ( std::string name )

inline

The system program are appended to the operating system default paths.

Parameters

name	System or program name.

StatePath()

std::string util::supervise::SystemInfo::StatePath ( ) const

nodiscard

Returns

Default state path.

---

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

• include/util/systeminfo.h