FlowEngine::SettingsInterface Class Reference

Stores the processing settings. More...

#include <SettingsInterface.h>

Public Member Functions
virtual FLE_DLL	~SettingsInterface ()=default
	Default virtual destructor.
virtual FLE_DLL Result	setValue (ConstStringBuffer category, ConstStringBuffer name, ConstStringBuffer value)=0
virtual FLE_DLL Result	getValue (ConstStringBuffer category, ConstStringBuffer name, StringBuffer outValue) const =0
virtual FLE_DLL Size	getValueLength (ConstStringBuffer category, ConstStringBuffer name) const =0
virtual FLE_DLL Index	getKeyCount (ConstStringBuffer category) const =0
virtual FLE_DLL Size	getKeyLength (ConstStringBuffer category, Index key) const =0
virtual FLE_DLL Result	getKey (ConstStringBuffer category, Index key, StringBuffer outKey) const =0
virtual FLE_DLL Result	save (ConstStringBuffer filePath) const =0
virtual FLE_DLL Result	load (ConstStringBuffer filePath)=0

Detailed Description

Stores the processing settings.

On construction, the object is filled with the default settings.

Constructor & Destructor Documentation

~SettingsInterface()

virtual FLE_DLL FlowEngine::SettingsInterface::~SettingsInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

getKey()

virtual FLE_DLL Result FlowEngine::SettingsInterface::getKey ( ConstStringBuffer  category, Index  key, StringBuffer  outKey  ) const

pure virtual

Returns

the key length at the given index.

Parameters

[in]	category	the settings category
[in]	key	the index of the key. Must be between [ 0, getKeyCount() )
[out]	outKey	the retrieved key

getKeyCount()

virtual FLE_DLL Index FlowEngine::SettingsInterface::getKeyCount ( ConstStringBuffer  category ) const

pure virtual

Returns

the number of keys in the settings

Parameters

[in]

category

the settings category

getKeyLength()

virtual FLE_DLL Size FlowEngine::SettingsInterface::getKeyLength ( ConstStringBuffer  category, Index  key  ) const

pure virtual

Returns

the key length at the given index.

Parameters

[in]	category	the settings category
[in]	key	the index of the key. Must be between [ 0, getKeyCount() )

getValue()

virtual FLE_DLL Result FlowEngine::SettingsInterface::getValue ( ConstStringBuffer  category, ConstStringBuffer  name, StringBuffer  outValue  ) const

pure virtual

Returns the value of the category/name entry in the settings.

Parameters

[in]	category	string buffer that contains the value category.
[in]	name	string buffer that contains the value name.
[out]	outValue	string buffer that receives the category/name entry value.

Returns

One of the following result codes:

• Result::Success – if the value was successfully retrieved
• Result::InvalidArgument – if category, name or value is not a valid string buffer.
• Result::BufferTooSmall – if value is not big enough to receive the settings value.

Note

If the category/name entry is not present in the settings, outValue receives an empty string.

getValueLength()

virtual FLE_DLL Size FlowEngine::SettingsInterface::getValueLength ( ConstStringBuffer  category, ConstStringBuffer  name  ) const

pure virtual

Get the length of a category/name entry value.

Parameters

[in]	category	string buffer that contains the value category.
[in]	name	string buffer that contains the value name.

Returns

the length of a settings value (excluding the termination character) or 0 if the category/name entry is not present.

load()

virtual FLE_DLL Result FlowEngine::SettingsInterface::load ( ConstStringBuffer  filePath )

pure virtual

Loads settings from an xml file.

Parameters

[in]

filePath

an UTF-8 encoded string containing the path to the file.

Returns

One of the following result codes:

• Result::Success – if settings are loaded successfully from the specified file path.
• Result::InvalidArgument – if filePath is not a valid string buffer.
• Result::InvalidArgument – if filePath does not point to a valid XML file.
• Result::FileNotFound – if filePath does not point to an existing file.
• Result::GenericError – if any other error occurred.

save()

virtual FLE_DLL Result FlowEngine::SettingsInterface::save ( ConstStringBuffer  filePath ) const

pure virtual

Saves settings to an xml file. Overwrites existing files

Parameters

[in]

filePath

an UTF-8 encoded string containing the target file path

setValue()

virtual FLE_DLL Result FlowEngine::SettingsInterface::setValue ( ConstStringBuffer  category, ConstStringBuffer  name, ConstStringBuffer  value  )

pure virtual

Change the value of a category/name entry in the settings. If category/name is already present its value is overwritten, otherwise a new entry is created.

Parameters

[in]	category	string buffer that contains the value category.
[in]	name	string buffer that contains the value name.
[in]	value	string buffer that contains the value.

Returns

One of the following result codes:

• Result::Success – if the value was successfully created/updated.
• Result::InvalidArgument – if category, name or value is not a valid string buffer.