fsdk::ISettingsProvider::Key Struct Reference

Configuration parameter key. More...

#include <ISettingsProvider.h>

Public Member Functions
	Key () noexcept
	Initialize an empty key.
	Key (const char *section, const char *parameter) noexcept
	Initialize a key. More...
const char *	getSection () const noexcept
	Get section name. More...
const char *	getParameter () const noexcept
	Get parameter name. More...
void	setSection (const char *section) noexcept
	Set section name. More...
void	setParameter (const char *parameter) noexcept
	Set parameter name. More...
bool	operator< (const ISettingsProvider::Key &other) const noexcept
	Operator Less. More...

Protected Attributes
char	m_section [m_bufferLength]
	Config section name.
char	m_parameter [m_bufferLength]
	Config parameter name.

Static Protected Attributes
static const unsigned int	m_bufferLength = 128

Detailed Description

Configuration parameter key.

Constructor & Destructor Documentation

fsdk::ISettingsProvider::Key::Key ( const char *  section, const char *  parameter  )

noexcept

Initialize a key.

Parameters

section	section name.
parameter	parameter name.

Member Function Documentation

const char* fsdk::ISettingsProvider::Key::getParameter ( ) const

noexcept

Get parameter name.

Returns

parameter name.

const char* fsdk::ISettingsProvider::Key::getSection ( ) const

noexcept

Get section name.

Returns

section name.

bool fsdk::ISettingsProvider::Key::operator< ( const ISettingsProvider::Key &  other ) const

noexcept

Operator Less.

Parameters

other

other key.

Returns

comparison result.

void fsdk::ISettingsProvider::Key::setParameter ( const char *  parameter )

noexcept

Set parameter name.

Parameters

parameter

parameter name.

void fsdk::ISettingsProvider::Key::setSection ( const char *  section )

noexcept

Set section name.

Parameters

section

section name.

---

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

• include/fsdk/ISettingsProvider.h