Chemical Data Processing Library C++ API - Version 1.1.1
Public Member Functions | List of all members
CDPL::Util::FileDataReader< ReaderImpl, DataType > Class Template Reference

FileDataReader. More...

#include <FileDataReader.hpp>

+ Inheritance diagram for CDPL::Util::FileDataReader< ReaderImpl, DataType >:

Public Member Functions

 FileDataReader (const std::string &file_name, std::ios_base::openmode mode=std::ios_base::in|std::ios_base::binary)
 
FileDataReaderread (DataType &obj, bool overwrite=true)
 
FileDataReaderread (std::size_t idx, DataType &obj, bool overwrite=true)
 
FileDataReaderskip ()
 Skips the data record at the current record index. More...
 
bool hasMoreData ()
 Tells if there are any data records left to read. More...
 
std::size_t getRecordIndex () const
 
void setRecordIndex (std::size_t idx)
 Sets the index of the current data record to idx. More...
 
std::size_t getNumRecords ()
 Returns the total number of available data records. More...
 
 operator const void * () const
 
bool operator! () const
 
void close ()
 Performs a reader specific shutdown operation (if required). More...
 
- Public Member Functions inherited from CDPL::Base::DataReader< typename ReaderImpl::DataType >
virtual DataReaderread (DataType &obj, bool overwrite=true)=0
 Reads the data record at the current record index and stores the read data in obj. More...
 
virtual DataReaderread (std::size_t idx, DataType &obj, bool overwrite=true)=0
 Reads the data record at index idx and stores the read data in obj. More...
 
virtual std::size_t getRecordIndex () const=0
 Returns the index of the current data record. More...
 
virtual operator const void * () const=0
 Returns a pointer whose value indicates the error state of the reader. More...
 
virtual bool operator! () const=0
 Tells whether the reader is in a bad state. More...
 
- Public Member Functions inherited from CDPL::Base::DataIOBase
std::size_t registerIOCallback (const IOCallbackFunction &func)
 Registers an I/O callback target function. More...
 
void unregisterIOCallback (std::size_t id)
 Unregisters the I/O callback function specified by id. More...
 
void invokeIOCallbacks (double progress) const
 Invokes all registered I/O callback functions with the argument *this. More...
 
void clearIOCallbacks ()
 Clears all registered I/O callback functions. More...
 
- Public Member Functions inherited from CDPL::Base::ControlParameterContainer
std::size_t getNumParameters () const
 Returns the number of container entries. More...
 
template<typename T >
void setParameter (const LookupKey &key, T &&val)
 Sets the value of the control-parameter specified by key to val. More...
 
const AnygetParameter (const LookupKey &key, bool throw_=false, bool local=false) const
 Returns the value of the control-parameter specified by key. More...
 
template<typename T >
const T & getParameter (const LookupKey &key, bool local=false) const
 Returns the value of the control-parameter specified by key as a const reference to an object of type T. More...
 
template<typename T >
const T & getParameterOrDefault (const LookupKey &key, const T &def_val, bool local=false) const
 Returns the value of the control-parameter specified by key as a const reference to an object of type T, or the default value def_val if a stored value does not exist. More...
 
bool removeParameter (const LookupKey &key)
 Removes the entry for the control-parameter specified by key. More...
 
void clearParameters ()
 Erases all container entries. More...
 
bool isParameterSet (const LookupKey &key, bool local=false) const
 Tells whether or not a value has been assigned to the control-parameter specified by key. More...
 
void addParameters (const ControlParameterContainer &cntnr)
 Adds the control-parameter value entries in the ControlParameterContainer instance cntnr. More...
 
void copyParameters (const ControlParameterContainer &cntnr)
 Replaces the current set of properties by a copy of the entries in cntnr. More...
 
ConstParameterIterator getParametersBegin () const
 Returns a constant iterator pointing to the beginning of the entries. More...
 
ConstParameterIterator getParametersEnd () const
 Returns a constant iterator pointing to the end of the entries. More...
 
ConstParameterIterator begin () const
 Returns a constant iterator pointing to the beginning of the entries. More...
 
ConstParameterIterator end () const
 Returns a constant iterator pointing to the end of the entries. More...
 
void setParent (const ControlParameterContainer *cntnr)
 Sets or removes the parent control-parameter container used to resolve requests for missing entries. More...
 
const ControlParameterContainergetParent () const
 Returns a pointer to the parent control-parameter container. More...
 
std::size_t registerParameterChangedCallback (const ParameterChangedCallbackFunction &func)
 Registers a callback target function that gets invoked when the value of a control-parameter has changed. More...
 
void unregisterParameterChangedCallback (std::size_t id)
 Unregisters the callback specified by id. More...
 
std::size_t registerParameterRemovedCallback (const ParameterRemovedCallbackFunction &func)
 Registers a callback target function that gets invoked when a control-parameter entry has been removed. More...
 
void unregisterParameterRemovedCallback (std::size_t id)
 Unregisters the callback specified by id. More...
 
std::size_t registerParentChangedCallback (const ParentChangedCallbackFunction &func)
 Registers a callback target function that gets invoked when the parent container has been changed or was detached. More...
 
void unregisterParentChangedCallback (std::size_t id)
 Unregisters the callback specified by id. More...
 
const ControlParameterContainergetParameters () const
 Returns a const reference to itself. More...
 

Additional Inherited Members

- Public Types inherited from CDPL::Base::DataReader< typename ReaderImpl::DataType >
typedef typename ReaderImpl::DataType DataType
 The type of the read data objects. More...
 
typedef std::shared_ptr< DataReaderSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated DataReader instances. More...
 
- Public Types inherited from CDPL::Base::DataIOBase
typedef std::function< void(const DataIOBase &, double)> IOCallbackFunction
 A functor class used to wrap I/O callback target functions. More...
 
- Public Types inherited from CDPL::Base::ControlParameterContainer
typedef ParameterMap::value_type ParameterEntry
 A Base::LookupKey / Base::Any pair used to store the control-parameter values and associated keys. More...
 
typedef ParameterMap::const_iterator ConstParameterIterator
 A constant iterator used to iterate over the control-parameter entries. More...
 
typedef std::function< void(const LookupKey &, const Any &)> ParameterChangedCallbackFunction
 A functor class that wraps callback target functions which get invoked when the value of a control-parameter has changed. More...
 
typedef std::function< void(const LookupKey &)> ParameterRemovedCallbackFunction
 A functor class that wraps callback target functions which get invoked when a control-parameter entry has been removed. More...
 
typedef std::function< void()> ParentChangedCallbackFunction
 A functor class that wraps callback target functions which get invoked when the parent container has been changed or was detached. More...
 
- Protected Member Functions inherited from CDPL::Base::DataReader< typename ReaderImpl::DataType >
DataReaderoperator= (const DataReader &reader)
 Assignment operator. More...
 
- Protected Member Functions inherited from CDPL::Base::DataIOBase
 DataIOBase ()
 Default constructor. More...
 
 DataIOBase (const DataIOBase &io_base)
 Copy constructor. More...
 
 ~DataIOBase ()
 Destructor. More...
 
DataIOBaseoperator= (const DataIOBase &io_base)
 Assignment operator. More...
 
- Protected Member Functions inherited from CDPL::Base::ControlParameterContainer
 ControlParameterContainer ()
 Constructs an empty ControlParameterContainer instance. More...
 
 ControlParameterContainer (const ControlParameterContainer &cntnr)
 Constructs a copy of the ControlParameterContainer instance cntnr. More...
 
virtual ~ControlParameterContainer ()
 Destructor. More...
 
ControlParameterContaineroperator= (const ControlParameterContainer &cntnr)
 Assignment operator. More...
 

Detailed Description

template<typename ReaderImpl, typename DataType = typename ReaderImpl::DataType>
class CDPL::Util::FileDataReader< ReaderImpl, DataType >

FileDataReader.

Constructor & Destructor Documentation

◆ FileDataReader()

template<typename ReaderImpl , typename DataType >
CDPL::Util::FileDataReader< ReaderImpl, DataType >::FileDataReader ( const std::string &  file_name,
std::ios_base::openmode  mode = std::ios_base::in | std::ios_base::binary 
)

Member Function Documentation

◆ read() [1/2]

template<typename ReaderImpl , typename DataType >
CDPL::Util::FileDataReader< ReaderImpl, DataType > & CDPL::Util::FileDataReader< ReaderImpl, DataType >::read ( DataType obj,
bool  overwrite = true 
)

◆ read() [2/2]

template<typename ReaderImpl , typename DataType >
CDPL::Util::FileDataReader< ReaderImpl, DataType > & CDPL::Util::FileDataReader< ReaderImpl, DataType >::read ( std::size_t  idx,
DataType obj,
bool  overwrite = true 
)

◆ skip()

template<typename ReaderImpl , typename DataType >
CDPL::Util::FileDataReader< ReaderImpl, DataType > & CDPL::Util::FileDataReader< ReaderImpl, DataType >::skip
virtual

Skips the data record at the current record index.

If the operation was successful, the record index is incremented by 1.

Returns
A reference to itself.
Exceptions
Base::IOErrorif an I/O error occurred.

Implements CDPL::Base::DataReader< typename ReaderImpl::DataType >.

◆ hasMoreData()

template<typename ReaderImpl , typename DataType >
bool CDPL::Util::FileDataReader< ReaderImpl, DataType >::hasMoreData
virtual

Tells if there are any data records left to read.

Returns
true if there are data records left to read, and false otherwise.
Exceptions
Base::IOErrorif an I/O error occurred.

Implements CDPL::Base::DataReader< typename ReaderImpl::DataType >.

◆ getRecordIndex()

template<typename ReaderImpl , typename DataType >
std::size_t CDPL::Util::FileDataReader< ReaderImpl, DataType >::getRecordIndex

◆ setRecordIndex()

template<typename ReaderImpl , typename DataType >
void CDPL::Util::FileDataReader< ReaderImpl, DataType >::setRecordIndex ( std::size_t  idx)
virtual

Sets the index of the current data record to idx.

Parameters
idxThe zero-based index of the data record.
Exceptions
Base::IndexErrorif idx is greater or equal to the number of available data records. Base::IOError if an I/O error occurred.

Implements CDPL::Base::DataReader< typename ReaderImpl::DataType >.

◆ getNumRecords()

template<typename ReaderImpl , typename DataType >
std::size_t CDPL::Util::FileDataReader< ReaderImpl, DataType >::getNumRecords
virtual

Returns the total number of available data records.

Returns
The total number of available data records.
Exceptions
Base::IOErrorif an I/O error occurred.

Implements CDPL::Base::DataReader< typename ReaderImpl::DataType >.

◆ operator const void *()

template<typename ReaderImpl , typename DataType >
CDPL::Util::FileDataReader< ReaderImpl, DataType >::operator const void *

◆ operator!()

template<typename ReaderImpl , typename DataType >
bool CDPL::Util::FileDataReader< ReaderImpl, DataType >::operator!

◆ close()

template<typename ReaderImpl , typename DataType >
void CDPL::Util::FileDataReader< ReaderImpl, DataType >::close
virtual

Performs a reader specific shutdown operation (if required).

Exceptions
Base::IOErrorif an I/O error occurred.

Reimplemented from CDPL::Base::DataReader< typename ReaderImpl::DataType >.


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