A toolkit for working with phylogenetic data.
v0.18.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
BaseInputSource Class Referenceabstract

#include <genesis/utils/io/input_source.hpp>

Inherited by FileInputSource, StreamInputSource, and StringInputSource.

Detailed Description

Abstract base class for reading byte data from input sources.

It offers to read() a certain amount of bytes into a char buffer.

Definition at line 54 of file input_source.hpp.

Public Member Functions

 BaseInputSource ()=default
 
 BaseInputSource (BaseInputSource const &)=default
 
 BaseInputSource (BaseInputSource &&)=default
 
virtual ~BaseInputSource ()
 
BaseInputSourceoperator= (BaseInputSource const &)=default
 
BaseInputSourceoperator= (BaseInputSource &&)=default
 
size_t read (char *buffer, size_t size)
 Read size many bytes into the char buffer. More...
 
std::string source_name () const
 Get a name of the input source. Mainly interesting for user output. More...
 

Constructor & Destructor Documentation

BaseInputSource ( )
default
BaseInputSource ( BaseInputSource const &  )
default
BaseInputSource ( BaseInputSource &&  )
default
virtual ~BaseInputSource ( )
inlinevirtual

Definition at line 70 of file input_source.hpp.

Member Function Documentation

BaseInputSource& operator= ( BaseInputSource const &  )
default
BaseInputSource& operator= ( BaseInputSource &&  )
default
size_t read ( char *  buffer,
size_t  size 
)
inline

Read size many bytes into the char buffer.

Definition at line 80 of file input_source.hpp.

std::string source_name ( ) const
inline

Get a name of the input source. Mainly interesting for user output.

Definition at line 89 of file input_source.hpp.


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