cee::imp::cae::ReaderSettingsDataProvider
-
class
ReaderSettingsDataProvider
Settings applicable to the DataProvider plugin reader.
represented with a: cee::Str providerIdString
and a collection of: [ key , value , DataType , description ]
Public Types
Public Functions
-
ReaderSettingsDataProvider
(const cee::Str &providerIdString) Constructs the reader settings object injecting the Data provider plugin id.
-
ReaderSettingsDataProvider
(const ReaderSettingsDataProvider &other) Constructs a ReaderSettingsDataProvider as a copy of other.
-
ReaderSettingsDataProvider &
operator=
(const ReaderSettingsDataProvider &other) Assigns other to this and returns a reference to this ReaderSettingsDataProvider instance.
-
const cee::Str &
providerIdString
() const Returns the name id of the Data provider plugin associated to these settings.
-
size_t
count
() const Returns number of user settings (options) of the data provider plugin.
-
const cee::Str &
description
(size_t index) const Returns a brief functionality explanation associated to the setting.
-
double
doubleValue
(size_t index) const If DataType = DOUBLE, returns the current setting value, otherwise returns cee::UNDEFINED_DOUBLE.
-
bool
boolValue
(size_t index) const If DataType = BOOL, returns the current setting value (true or false), otherwise returns false.
-
const cee::Str &
stringValue
(size_t index) const If DataType = STRING, returns the current setting value, otherwise returns string “UNDEFINED”.
-
size_t
keyIndex
(const cee::Str &key) const Returns position index whose setting key equals the input. If not found, returns cee::UNDEFINED_SIZE_T.
-
void
setDoubleValue
(const cee::Str &key, double value) If key exists, sets its value. Otherwise, inserts new key-value of DataType::DOUBLE.
-
void
setBoolValue
(const cee::Str &key, bool value) If key exists, sets its value. Otherwise, inserts new key-value of DataType::BOOL.
-