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

Data sink/writer abstract interface. More...

#include <bayeux/dpp/i_data_sink.h>

Inheritance diagram for dpp::i_data_sink:
dpp::simple_brio_data_sink dpp::simple_data_sink

Classes

struct  sink_record
 Internal class of the i_data_sink 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...
 
void set_preserve_existing_sink (bool value_)
 
bool is_preserve_existing_sink () const
 
virtual bool is_open () const
 
virtual bool is_sequential () const
 
virtual bool is_random () const
 
virtual void set (const std::string &sink_label_)
 
virtual void open ()=0
 
virtual bool store_next_record (const datatools::things &event_record_)=0
 
virtual bool can_store_meta_data () const =0
 
virtual bool store_metadata (const datatools::properties &meta_data_)=0
 
virtual void close ()=0
 
virtual void reset ()=0
 
 i_data_sink (datatools::logger::priority priority_=datatools::logger::PRIO_ERROR)
 
 i_data_sink (const std::string &sink_label_, datatools::logger::priority priority_=datatools::logger::PRIO_ERROR)
 
virtual ~i_data_sink ()
 

Protected Member Functions

void _set_defaults (datatools::logger::priority priority_)
 

Protected Attributes

datatools::logger::priority _logging
 The logging priority. More...
 
bool _preserve_existing_sink
 Preserve flag. More...
 
sink_record _sink_record
 Record dynamic informations about the data sink. More...
 

Detailed Description

Data sink/writer abstract interface.

Constructor & Destructor Documentation

◆ i_data_sink() [1/2]

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

◆ i_data_sink() [2/2]

dpp::i_data_sink::i_data_sink ( const std::string &  sink_label_,
datatools::logger::priority  priority_ = datatools::logger::PRIO_ERROR 
)

◆ ~i_data_sink()

virtual dpp::i_data_sink::~i_data_sink ( )
virtual

Member Function Documentation

◆ _set_defaults()

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

◆ can_store_meta_data()

virtual bool dpp::i_data_sink::can_store_meta_data ( ) const
pure virtual

◆ close()

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

◆ get_logging_priority()

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

Returns logging priority.

◆ is_open()

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

◆ is_preserve_existing_sink()

bool dpp::i_data_sink::is_preserve_existing_sink ( ) const

◆ is_random()

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

Reimplemented in dpp::simple_brio_data_sink.

◆ is_sequential()

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

◆ open()

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

◆ reset()

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

◆ set()

virtual void dpp::i_data_sink::set ( const std::string &  sink_label_)
virtual

◆ set_logging_priority()

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

Set logging priority.

◆ set_preserve_existing_sink()

void dpp::i_data_sink::set_preserve_existing_sink ( bool  value_)

◆ store_metadata()

virtual bool dpp::i_data_sink::store_metadata ( const datatools::properties meta_data_)
pure virtual

◆ store_next_record()

virtual bool dpp::i_data_sink::store_next_record ( const datatools::things event_record_)
pure virtual

Member Data Documentation

◆ _logging

datatools::logger::priority dpp::i_data_sink::_logging
protected

The logging priority.

◆ _preserve_existing_sink

bool dpp::i_data_sink::_preserve_existing_sink
protected

Preserve flag.

◆ _sink_record

sink_record dpp::i_data_sink::_sink_record
protected

Record dynamic informations about the data sink.


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