MyScript Interactive Ink SDK 4.3.0
Public Member Functions | List of all members
myscript::iink::Configuration Class Referenceabstract

#include <Configuration.h>

Inheritance diagram for myscript::iink::Configuration:
myscript::iink::ParameterSet

Public Member Functions

virtual ~Configuration ()=default
 
virtual void reset ()=0
 
virtual void addListener (std::shared_ptr< IConfigurationListener > listener)=0
 
virtual void removeListener (std::shared_ptr< IConfigurationListener > listener)=0
 
- Public Member Functions inherited from myscript::iink::ParameterSet
virtual ~ParameterSet ()=default
 
virtual void inject (const String &jsonText)=0
 
virtual String getString (const String &key) const =0
 
virtual String getString (const String &key, const String &defaultValue) const =0
 
virtual void setString (const String &key, const String &value)=0
 
virtual bool getBoolean (const String &key) const =0
 
virtual bool getBoolean (const String &key, bool defaultValue) const =0
 
virtual void setBoolean (const String &key, bool value)=0
 
virtual double getNumber (const String &key) const =0
 
virtual double getNumber (const String &key, double defaultValue) const =0
 
virtual void setNumber (const String &key, double value)=0
 
virtual std::vector< String > getStringArray (const String &key) const =0
 
virtual std::vector< String > getStringArray (const String &key, const std::vector< String > &defaultValue) const =0
 
virtual void setStringArray (const String &key, const std::vector< String > &value)=0
 
virtual std::vector< double > getNumberArray (const String &key) const =0
 
virtual std::vector< double > getNumberArray (const String &key, const std::vector< double > &defaultValue) const =0
 
virtual void setNumberArray (const String &key, const std::vector< double > &value)=0
 
virtual std::shared_ptr< ParameterSet > getSection (const String &key)=0
 

Detailed Description

Represents the configuration values of the iink runtime environment.

Constructor & Destructor Documentation

◆ ~Configuration()

virtual myscript::iink::Configuration::~Configuration ( )
virtualdefault

Member Function Documentation

◆ reset()

virtual void myscript::iink::Configuration::reset ( )
pure virtual

Resets this configuration to its default values.

◆ addListener()

virtual void myscript::iink::Configuration::addListener ( std::shared_ptr< IConfigurationListener >  listener)
pure virtual

Adds the specified listener to this configuration.

Parameters
listenerthe listener to be added.
Exceptions
std::invalid_argumentwhen listener is nullptr.

◆ removeListener()

virtual void myscript::iink::Configuration::removeListener ( std::shared_ptr< IConfigurationListener >  listener)
pure virtual

Removes the specified listener from this configuration.

Parameters
listenerthe listener to be removed.
Exceptions
std::invalid_argumentwhen listener is nullptr.

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