checksum::base Class Reference

#include <checksumBase.h>

Inheritance diagram for checksum::base:

Collaboration diagram for checksum::base:

Classes
class	factoryClass
class	factoryTemplate

Public Member Functions
virtual	~base ()=default
virtual bool	parallelizable () const
const std::string &	getName () const
const std::string &	getResult () const
void	setExpectedResult (const std::string &expectedResult)
const std::string &	getExpectedResult () const
bool	checkExpectation () const
virtual void	update (void *data, size_t size)=0
virtual void	update (size_t size)=0
virtual void	finish ()=0

Static Public Member Functions
static factoryClass *	newFactory (const std::string &aName)
template<class T >
static void	addAllowedNamesToOption (T &option)

Protected Member Functions
	base (const std::string &aName)

Static Protected Member Functions
static std::map< std::string, factoryClass * > &	getFactoryMap ()

Protected Attributes
const std::string &	name
std::string	result
std::string	expected

Detailed Description

Definition at line 8 of file checksumBase.h.

Constructor & Destructor Documentation

base()

checksum::base::base ( const std::string &  aName )

inlineexplicitprotected

Definition at line 40 of file checksumBase.h.

: name(aName) {}

~base()

virtual checksum::base::~base ( )

virtualdefault

Member Function Documentation

addAllowedNamesToOption()

template<class T >

static void checksum::base::addAllowedNamesToOption ( T &  option )

inlinestatic

Definition at line 75 of file checksumBase.h.

                                                                          {
            for (const auto& item : getFactoryMap()) {
                option.fAddToRange(item.first);
            }
        };

References getFactoryMap().

Here is the call graph for this function:

checkExpectation()

bool checksum::base::checkExpectation ( ) const

inline

Definition at line 58 of file checksumBase.h.

                                      {
            if (expected.empty()) { // always agree on unset expectation
                return true;
            }
            return result == expected;
        }

References expected, and result.

finish()

virtual void checksum::base::finish ( )

pure virtual

Implemented in checksum::crc32, checksum::md5sum, checksum::adler32, and checksum::sslSum.

getExpectedResult()

const std::string& checksum::base::getExpectedResult ( ) const

inline

Definition at line 55 of file checksumBase.h.

                                                   {
            return expected;
        }

References expected.

getFactoryMap()

static std::map<std::string, factoryClass*>& checksum::base::getFactoryMap ( )

inlinestaticprotected

Definition at line 13 of file checksumBase.h.

                                                                 {
            static std::remove_reference<decltype(getFactoryMap())>::type map;
            return map;
        }

Referenced by addAllowedNamesToOption(), checksum::base::factoryClass::factoryClass(), and newFactory().

Here is the caller graph for this function:

getName()

const std::string& checksum::base::getName ( ) const

inline

Definition at line 46 of file checksumBase.h.

                                         {
            return name;
        };

References name.

getResult()

const std::string& checksum::base::getResult ( ) const

inline

Definition at line 49 of file checksumBase.h.

                                           {
            return result;
        };

References result.

newFactory()

static factoryClass* checksum::base::newFactory ( const std::string &  aName )

inlinestatic

Definition at line 68 of file checksumBase.h.

                                                                {
            auto it = getFactoryMap().find(aName);
            if (it != getFactoryMap().end()) {
                return it->second;
            }
            throw std::runtime_error("no checksum factory called " + aName);
        }

References getFactoryMap().

Referenced by copyRequest::base::addExpectedChecksumResult().

Here is the call graph for this function:

Here is the caller graph for this function:

parallelizable()

virtual bool checksum::base::parallelizable ( ) const

inlinevirtual

Reimplemented in checksum::crc32, and checksum::adler32.

Definition at line 43 of file checksumBase.h.

                                            {
            return false;
        }

setExpectedResult()

void checksum::base::setExpectedResult ( const std::string &  expectedResult )

inline

Definition at line 52 of file checksumBase.h.

                                                                {
            expected = expectedResult;
        }

References expected.

update() [1/2]

virtual void checksum::base::update ( size_t  size )

pure virtual

Implemented in checksum::crc32, checksum::adler32noOpt, checksum::md5sum, checksum::adler32, and checksum::sslSum.

update() [2/2]

virtual void checksum::base::update ( void *  data, size_t  size  )

pure virtual

Implemented in checksum::crc32, checksum::adler32noOpt, checksum::md5sum, checksum::adler32, and checksum::sslSum.

Member Data Documentation

expected

std::string checksum::base::expected

protected

Definition at line 39 of file checksumBase.h.

Referenced by checkExpectation(), getExpectedResult(), and setExpectedResult().

name

const std::string& checksum::base::name

protected

Definition at line 37 of file checksumBase.h.

Referenced by checksum::sslSum::createFactoryCallback(), getName(), and checksum::sslSum::sslSum().

result

std::string checksum::base::result

protected

Definition at line 38 of file checksumBase.h.

Referenced by checkExpectation(), checksum::adler32::finish(), checksum::sslSum::finish(), checksum::md5sum::finish(), checksum::crc32::finish(), and getResult().

---

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

• src/checksumBase.h (v0.19-24-g0617ca1 with changes)