IoT::Settings

class ISettingsService

File Information

Library: IoT/Settings
Package: Generated
Header: IoT/Settings/ISettingsService.h

Description

The SettingsService provides a service interface to the configuration system. Specifically it allows to change configuration parameters and to save changed parameters in a file.

Inheritance

Direct Base Classes: Poco::OSP::Service

All Base Classes: Poco::OSP::Service, Poco::RefCountedObject

Known Derived Classes: SettingsServiceRemoteObject

Member Summary

Member Functions: getBool, getDouble, getInt16, getInt32, getInt64, getString, getUInt16, getUInt32, getUInt64, haveKey, haveSettingsKey, isA, keys, remoting__typeId, remove, save, setBool, setDouble, setInt16, setInt32, setInt64, setString, setUInt16, setUInt32, setUInt64, settingsKeys, type

Inherited Functions: duplicate, isA, referenceCount, release, type

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < ISettingsService >;

Constructors

ISettingsService

ISettingsService();

Creates a ISettingsService.

Destructor

~ISettingsService virtual

virtual ~ISettingsService();

Destroys the ISettingsService.

Member Functions

getBool virtual

virtual Poco::Optional < double > getBool(
    const std::string & key,
    const Poco::Optional < double > & deflt = Poco::Optional < double > ()
) const = 0;

Returns the boolean value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException if the property value can not be converted to a boolean value.

The following string values can be converted into a boolean:

  • numerical values: non-zero becomes true, zero becomes false
  • strings: "true", "yes", "on" become true, "false", "no", "off" become false

Case does not matter.

getDouble virtual

virtual Poco::Optional < double > getDouble(
    const std::string & key,
    const Poco::Optional < double > & deflt = Poco::Optional < double > ()
) const = 0;

Returns the double value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException if the property value can not be converted to a double value.

getInt16 virtual

virtual Poco::Optional < Poco::Int16 > getInt16(
    const std::string & key,
    const Poco::Optional < Poco::Int16 > & deflt = Poco::Optional < Poco::Int16 > ()
) const = 0;

Returns the 16-bit integer value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException or a Poco::RangeException if the property value can not be converted to an Int16 value.

getInt32 virtual

virtual Poco::Optional < Poco::Int32 > getInt32(
    const std::string & key,
    const Poco::Optional < Poco::Int32 > & deflt = Poco::Optional < Poco::Int32 > ()
) const = 0;

Returns the 32-bit integer value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException or a Poco::RangeException if the property value can not be converted to an Int32 value.

getInt64 virtual

virtual Poco::Optional < Poco::Int64 > getInt64(
    const std::string & key,
    const Poco::Optional < Poco::Int64 > & deflt = Poco::Optional < Poco::Int64 > ()
) const = 0;

Returns the 64-bit integer value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException if the property value can not be converted to an Int64 value.

getString virtual

virtual Poco::Optional < std::string > getString(
    const std::string & key,
    const Poco::Optional < std::string > & deflt = Poco::Optional < std::string > ()
) const = 0;

Returns the string value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

getUInt16 virtual

virtual Poco::Optional < Poco::UInt16 > getUInt16(
    const std::string & key,
    const Poco::Optional < Poco::UInt16 > & deflt = Poco::Optional < Poco::UInt16 > ()
) const = 0;

Returns the 16-bit unsigned integer value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException or a Poco::RangeException if the property value can not be converted to an UInt16 value.

getUInt32 virtual

virtual Poco::Optional < Poco::UInt32 > getUInt32(
    const std::string & key,
    const Poco::Optional < Poco::UInt32 > & deflt = Poco::Optional < Poco::UInt32 > ()
) const = 0;

Returns the 32-bit unsigned integer value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException or a Poco::RangeException if the property value can not be converted to an UInt32 value.

getUInt64 virtual

virtual Poco::Optional < Poco::UInt64 > getUInt64(
    const std::string & key,
    const Poco::Optional < Poco::UInt64 > & deflt = Poco::Optional < Poco::UInt64 > ()
) const = 0;

Returns the 64-bit unsigned integer value of the property with the given key, or the given default value if the key does not exist. If the value contains references to other properties (${<property>}, or ${<property>:-<default>}), these are expanded.

Throws a Poco::SyntaxException or a Poco::RangeException if the property value can not be converted to an UInt64 value.

haveKey virtual

virtual bool haveKey(
    const std::string & key
) const = 0;

Returns true if the given key exists (either in the settings configuration, or in the global configuration), otherwise false.

haveSettingsKey virtual

virtual bool haveSettingsKey(
    const std::string & key
) const = 0;

Returns true if the given key is defined in the settings configuration object, otherwise false.

isA virtual

bool isA(
    const std::type_info & otherType
) const;

Returns true if the class is a subclass of the class given by otherType.

See also: Poco::OSP::Service::isA()

keys virtual

virtual std::vector < std::string > keys(
    const std::string & key = std::string ()
) const = 0;

Returns in range the names of all subkeys under the given key. If an empty key is passed, all root level keys are returned.

remoting__typeId static

static const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId();

Returns the TypeId of the class.

remove virtual

virtual void remove(
    const std::string & key
) = 0;

Removes the value with the given key from the settings configuration.

save virtual

virtual void save() const = 0;

Saves the settings file to disk.

setBool virtual

virtual void setBool(
    const std::string & key,
    bool value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setDouble virtual

virtual void setDouble(
    const std::string & key,
    double value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setInt16 virtual

virtual void setInt16(
    const std::string & key,
    Poco::Int16 value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setInt32 virtual

virtual void setInt32(
    const std::string & key,
    Poco::Int32 value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setInt64 virtual

virtual void setInt64(
    const std::string & key,
    Poco::Int64 value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setString virtual

virtual void setString(
    const std::string & key,
    const std::string & value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setUInt16 virtual

virtual void setUInt16(
    const std::string & key,
    Poco::UInt16 value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setUInt32 virtual

virtual void setUInt32(
    const std::string & key,
    Poco::UInt32 value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

setUInt64 virtual

virtual void setUInt64(
    const std::string & key,
    Poco::UInt64 value
) = 0;

Sets the property with the given key to the given value. An already existing value for the key is overwritten.

The new value is not persisted. Call save() to persist changes.

settingsKeys virtual

virtual std::vector < std::string > settingsKeys(
    const std::string & key = std::string ()
) const = 0;

Returns in range the names of all subkeys under the given key. If an empty key is passed, all root level keys are returned.

Only keys from the underlying settings configuration object are returned.

type virtual

const std::type_info & type() const;

Returns the type information for the object's class.

See also: Poco::OSP::Service::type()

Securely control IoT edge devices from anywhere   Connect a Device