cee::imp::cae::ReaderSettingsDataProvider Class Reference

Settings applicable to the DataProvider plugin reader. More...

Public Types

enum  DataType { DOUBLE, BOOL, STRING }
 Data value types. More...
 

Public Member Functions

 ReaderSettingsDataProvider (const cee::Str &providerIdString)
 Constructs the reader settings object injecting the Data provider plugin id. More...
 
 ReaderSettingsDataProvider (const ReaderSettingsDataProvider &other)
 Constructs a ReaderSettingsDataProvider as a copy of other. More...
 
ReaderSettingsDataProvideroperator= (const ReaderSettingsDataProvider &other)
 Assigns other to this and returns a reference to this ReaderSettingsDataProvider instance. More...
 
const cee::StrproviderIdString () const
 Returns the name id of the Data provider plugin associated to these settings. More...
 
size_t count () const
 Returns number of user settings (options) of the data provider plugin. More...
 
const cee::Strkey (size_t index) const
 Returns the key at index position. More...
 
DataType dataType (size_t index) const
 Returns the DataType (DOUBLE,BOOL,STRING) at index position. More...
 
const cee::Strdescription (size_t index) const
 Returns a brief functionality explanation associated to the setting. More...
 
double doubleValue (size_t index) const
 If DataType = DOUBLE, returns the current setting value, otherwise returns cee::UNDEFINED_DOUBLE. More...
 
bool boolValue (size_t index) const
 If DataType = BOOL, returns the current setting value (true or false), otherwise returns false. More...
 
const cee::StrstringValue (size_t index) const
 If DataType = STRING, returns the current setting value, otherwise returns string "UNDEFINED". More...
 
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. More...
 
void setDoubleValue (const cee::Str &key, double value)
 If key exist, set its value. Otherwise, insert new key-value of DataType::DOUBLE. More...
 
void setBoolValue (const cee::Str &key, bool value)
 If key exist, set its value. Otherwise, insert new key-value of DataType::BOOL. More...
 
void setStringValue (const cee::Str &key, const cee::Str &value)
 If key exist, set its value. Otherwise, insert new key-value of DataType::STRING. More...
 
void setDescription (const cee::Str &key, const cee::Str &description)
 Sets description associated to the key. Do nothing if key not found. More...
 

Detailed Description

Settings applicable to the DataProvider plugin reader.

represented with a: cee::Str providerIdString

and a collection of: [ key , value , DataType , description ]

Member Enumeration Documentation

Data value types.

Enumerator
DOUBLE 

Enum to indicates that value is a double.

BOOL 

Enum to indicates that value is a boolean.

STRING 

Enum to indicates that value is a string.

Constructor & Destructor Documentation

cee::imp::cae::ReaderSettingsDataProvider::ReaderSettingsDataProvider ( const cee::Str providerIdString)

Constructs the reader settings object injecting the Data provider plugin id.

cee::imp::cae::ReaderSettingsDataProvider::ReaderSettingsDataProvider ( const ReaderSettingsDataProvider other)

Constructs a ReaderSettingsDataProvider as a copy of other.

Member Function Documentation

bool cee::imp::cae::ReaderSettingsDataProvider::boolValue ( size_t  index) const

If DataType = BOOL, returns the current setting value (true or false), otherwise returns false.

size_t cee::imp::cae::ReaderSettingsDataProvider::count ( ) const

Returns number of user settings (options) of the data provider plugin.

ReaderSettingsDataProvider::DataType cee::imp::cae::ReaderSettingsDataProvider::dataType ( size_t  index) const

Returns the DataType (DOUBLE,BOOL,STRING) at index position.

const cee::Str & cee::imp::cae::ReaderSettingsDataProvider::description ( size_t  index) const

Returns a brief functionality explanation associated to the setting.

double cee::imp::cae::ReaderSettingsDataProvider::doubleValue ( size_t  index) const

If DataType = DOUBLE, returns the current setting value, otherwise returns cee::UNDEFINED_DOUBLE.

const cee::Str & cee::imp::cae::ReaderSettingsDataProvider::key ( size_t  index) const

Returns the key at index position.

size_t cee::imp::cae::ReaderSettingsDataProvider::keyIndex ( const cee::Str key) const

Returns position index whose setting key equals the input. If not found, returns cee::UNDEFINED_SIZE_T.

ReaderSettingsDataProvider & cee::imp::cae::ReaderSettingsDataProvider::operator= ( const ReaderSettingsDataProvider other)

Assigns other to this and returns a reference to this ReaderSettingsDataProvider instance.

const cee::Str & cee::imp::cae::ReaderSettingsDataProvider::providerIdString ( ) const

Returns the name id of the Data provider plugin associated to these settings.

void cee::imp::cae::ReaderSettingsDataProvider::setBoolValue ( const cee::Str key,
bool  value 
)

If key exist, set its value. Otherwise, insert new key-value of DataType::BOOL.

void cee::imp::cae::ReaderSettingsDataProvider::setDescription ( const cee::Str key,
const cee::Str description 
)

Sets description associated to the key. Do nothing if key not found.

void cee::imp::cae::ReaderSettingsDataProvider::setDoubleValue ( const cee::Str key,
double  value 
)

If key exist, set its value. Otherwise, insert new key-value of DataType::DOUBLE.

void cee::imp::cae::ReaderSettingsDataProvider::setStringValue ( const cee::Str key,
const cee::Str value 
)

If key exist, set its value. Otherwise, insert new key-value of DataType::STRING.

const cee::Str & cee::imp::cae::ReaderSettingsDataProvider::stringValue ( size_t  index) const

If DataType = STRING, returns the current setting value, otherwise returns string "UNDEFINED".