Bayeux  3.4.1
Core Foundation library for SuperNEMO
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
dpp::i_data_source Class Referenceabstract

Data source/reader abstract interface. More...

#include <bayeux/dpp/i_data_source.h>

Inheritance diagram for dpp::i_data_source:
dpp::simple_brio_data_source dpp::simple_data_source

Classes

struct  source_record
 Internal class of the i_data_source interface class. More...
 

Public Member Functions

void set_logging_priority (datatools::logger::priority p_)
 Set logging priority. More...
 
datatools::logger::priority get_logging_priority () const
 Returns logging priority. More...
 
virtual bool is_open () const
 
virtual bool is_sequential () const
 
virtual bool is_random () const
 
virtual void set (const std::string &source_label_)
 
virtual void open ()=0
 
virtual bool can_load_record (int64_t entry_)
 
virtual bool has_next_record ()=0
 
virtual bool load_next_record (datatools::things &event_record_)=0
 
virtual bool has_number_of_entries () const
 
virtual int64_t get_number_of_entries () const
 
virtual bool load_record (datatools::things &event_record_, int64_t entry_)
 
virtual int64_t get_number_of_metadata () const =0
 
virtual bool load_metadata (datatools::properties &metadata_, int64_t entry_)=0
 
virtual void close ()=0
 
virtual void reset ()=0
 
 i_data_source (datatools::logger::priority priority_=datatools::logger::PRIO_ERROR)
 Constructor. More...
 
 i_data_source (const std::string &source_label_, datatools::logger::priority priority_=datatools::logger::PRIO_ERROR)
 Constructor. More...
 
virtual ~i_data_source ()
 Destructor: More...
 

Static Public Attributes

static const int64_t UNKNOWN_NUMBER_OF_ENTRIES = -1
 

Protected Member Functions

void _set_defaults (datatools::logger::priority priority_)
 
virtual void _check_next_record ()=0
 
virtual bool _load_record (datatools::things &event_record_, int64_t entry_)
 
virtual int64_t _get_number_of_entries () const
 

Protected Attributes

datatools::logger::priority _logging
 The logging priority. More...
 
bool _has_next_record
 Next record flag. More...
 
source_record _source_record
 Record dynamic informations about the data source. More...
 

Detailed Description

Data source/reader abstract interface.

Constructor & Destructor Documentation

◆ i_data_source() [1/2]

dpp::i_data_source::i_data_source ( datatools::logger::priority  priority_ = datatools::logger::PRIO_ERROR)

Constructor.

◆ i_data_source() [2/2]

dpp::i_data_source::i_data_source ( const std::string &  source_label_,
datatools::logger::priority  priority_ = datatools::logger::PRIO_ERROR 
)

Constructor.

◆ ~i_data_source()

virtual dpp::i_data_source::~i_data_source ( )
virtual

Destructor:

Member Function Documentation

◆ _check_next_record()

virtual void dpp::i_data_source::_check_next_record ( )
protectedpure virtual

◆ _get_number_of_entries()

virtual int64_t dpp::i_data_source::_get_number_of_entries ( ) const
protectedvirtual

Reimplemented in dpp::simple_brio_data_source.

◆ _load_record()

virtual bool dpp::i_data_source::_load_record ( datatools::things event_record_,
int64_t  entry_ 
)
protectedvirtual

Reimplemented in dpp::simple_brio_data_source.

◆ _set_defaults()

void dpp::i_data_source::_set_defaults ( datatools::logger::priority  priority_)
protected

◆ can_load_record()

virtual bool dpp::i_data_source::can_load_record ( int64_t  entry_)
virtual

◆ close()

virtual void dpp::i_data_source::close ( )
pure virtual

◆ get_logging_priority()

datatools::logger::priority dpp::i_data_source::get_logging_priority ( ) const

Returns logging priority.

◆ get_number_of_entries()

virtual int64_t dpp::i_data_source::get_number_of_entries ( ) const
virtual

◆ get_number_of_metadata()

virtual int64_t dpp::i_data_source::get_number_of_metadata ( ) const
pure virtual

◆ has_next_record()

virtual bool dpp::i_data_source::has_next_record ( )
pure virtual

◆ has_number_of_entries()

virtual bool dpp::i_data_source::has_number_of_entries ( ) const
virtual

◆ is_open()

virtual bool dpp::i_data_source::is_open ( ) const
virtual

◆ is_random()

virtual bool dpp::i_data_source::is_random ( ) const
virtual

Reimplemented in dpp::simple_brio_data_source.

◆ is_sequential()

virtual bool dpp::i_data_source::is_sequential ( ) const
virtual

◆ load_metadata()

virtual bool dpp::i_data_source::load_metadata ( datatools::properties metadata_,
int64_t  entry_ 
)
pure virtual

◆ load_next_record()

virtual bool dpp::i_data_source::load_next_record ( datatools::things event_record_)
pure virtual

◆ load_record()

virtual bool dpp::i_data_source::load_record ( datatools::things event_record_,
int64_t  entry_ 
)
virtual

◆ open()

virtual void dpp::i_data_source::open ( )
pure virtual

◆ reset()

virtual void dpp::i_data_source::reset ( )
pure virtual

◆ set()

virtual void dpp::i_data_source::set ( const std::string &  source_label_)
virtual

◆ set_logging_priority()

void dpp::i_data_source::set_logging_priority ( datatools::logger::priority  p_)

Set logging priority.

Member Data Documentation

◆ _has_next_record

bool dpp::i_data_source::_has_next_record
protected

Next record flag.

◆ _logging

datatools::logger::priority dpp::i_data_source::_logging
protected

The logging priority.

◆ _source_record

source_record dpp::i_data_source::_source_record
protected

Record dynamic informations about the data source.

◆ UNKNOWN_NUMBER_OF_ENTRIES

const int64_t dpp::i_data_source::UNKNOWN_NUMBER_OF_ENTRIES = -1
static

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