soma-io  5.0.5
soma::DefaultItemReader< T > Class Template Reference

Default low-levels readers. More...

#include <soma-io/reader/itemreader.h>

Inheritance diagram for soma::DefaultItemReader< T >:
Collaboration diagram for soma::DefaultItemReader< T >:

Public Member Functions

 DefaultItemReader ()
 
virtual ~DefaultItemReader ()
 
virtual ItemReader< T > * reader (bool binary=true, bool bswap=false) const
 Factory function. More...
 
virtual long read (DataSource &ds, T *pitem, size_t n=1) const
 Reading on an arbitrary DataSource. More...
 
template<>
ItemReader< int8_t > * reader (bool binary, bool) const
 Factory function. More...
 
template<>
ItemReader< uint8_t > * reader (bool binary, bool) const
 Factory function. More...
 
- Public Member Functions inherited from soma::ItemReader< T >
virtual ~ItemReader ()
 

Detailed Description

template<typename T>
class soma::DefaultItemReader< T >

Default low-levels readers.

They are a default implementation of the readers for most common types, and can be specialized for other types if needed.

Definition at line 105 of file itemreader.h.

Constructor & Destructor Documentation

◆ DefaultItemReader()

template<typename T >
soma::DefaultItemReader< T >::DefaultItemReader ( )
inline

Definition at line 108 of file itemreader.h.

◆ ~DefaultItemReader()

template<typename T >
virtual soma::DefaultItemReader< T >::~DefaultItemReader ( )
inlinevirtual

Definition at line 109 of file itemreader.h.

References soma::ItemReader< T >::read(), and soma::ItemReader< T >::reader().

Member Function Documentation

◆ read()

template<typename T >
long soma::DefaultItemReader< T >::read ( DataSource ds,
T *  pitem,
size_t  n = 1 
) const
inlinevirtual

Reading on an arbitrary DataSource.

Parameters
dssource of data (file, buffer, socket...)
pitembuffer to fill with read values
nnumber of elements to read
Returns
number of elements actually read

Implements soma::ItemReader< T >.

Reimplemented in soma::DefaultBSwapItemReader< T >, and soma::DefaultAsciiItemReader< T >.

Definition at line 181 of file itemreader.h.

References soma::DataSource::readBlock().

◆ reader() [1/3]

template<typename T >
ItemReader< T > * soma::DefaultItemReader< T >::reader ( bool  binary = true,
bool  bswap = false 
) const
inlinevirtual

Factory function.

Implements soma::ItemReader< T >.

Definition at line 147 of file itemreader.h.

◆ reader() [2/3]

template<>
ItemReader< int8_t > * soma::DefaultItemReader< int8_t >::reader ( bool  binary,
bool  bswap 
) const
inlinevirtual

Factory function.

Implements soma::ItemReader< T >.

Definition at line 159 of file itemreader.h.

◆ reader() [3/3]

template<>
ItemReader< uint8_t > * soma::DefaultItemReader< uint8_t >::reader ( bool  binary,
bool  bswap 
) const
inlinevirtual

Factory function.

Implements soma::ItemReader< T >.

Definition at line 170 of file itemreader.h.


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