be_io_properties.h

Go to the documentation of this file.

/******************************************************************************
 * This software was developed at the National Institute of Standards and
 * Technology (NIST) by employees of the Federal Government in the course
 * of their official duties. Pursuant to title 17 Section 105 of the
 * United States Code, this software is not subject to copyright protection
 * and is in the public domain. NIST assumes no responsibility whatsoever for
 * its use by other parties, and makes no guarantees, expressed or implied,
 * about its quality, reliability, or any other characteristic.
 ******************************************************************************/
#ifndef __BE_IO_PROPERTIES_H__
#define __BE_IO_PROPERTIES_H__
 
#include <map>
#include <string>
#include <vector>
 
#include <be_error_exception.h>
#include <be_io.h>
#include <be_memory_autoarray.h>
 
namespace BiometricEvaluation
{
        namespace IO
        {
                class Properties {
                public:
                        Properties(
                            IO::Mode mode = IO::Mode::ReadWrite,
                            const std::map<std::string, std::string>
                            &defaults = {});
                        
                        Properties(
                            const uint8_t *buffer,
                            const size_t size,
                            IO::Mode mode = IO::Mode::ReadWrite,
                            const std::map<std::string, std::string>
                            &defaults = {});
 
                        virtual void
                        setProperty(
                            const std::string &property,
                            const std::string &value);
 
                        virtual void
                        setPropertyFromInteger(
                            const std::string &property,
                            int64_t value);
 
                        virtual void
                        setPropertyFromDouble(
                            const std::string &property,
                            double value);
 
                        virtual void
                        setPropertyFromBoolean(
                            const std::string &property,
                            bool value);
 
                        virtual void
                        removeProperty(
                            const std::string &property);
 
                        virtual std::string
                        getProperty(
                            const std::string &property) const;
 
                        virtual int64_t
                        getPropertyAsInteger(
                            const std::string &property) const;
 
                        virtual double
                        getPropertyAsDouble(
                            const std::string &property) const;
 
                        virtual bool
                        getPropertyAsBoolean(
                            const std::string &property)
                            const;
 
                        std::vector<std::string>
                        getPropertyKeys() const;
 
                        virtual ~Properties();
 
                protected:
                        BiometricEvaluation::IO::Mode
                        getMode()
                            const;
                            
                        void
                        initWithBuffer(
                            const Memory::uint8Array &buffer,
                            const std::map<std::string, std::string> &defaults);
 
                        void
                        initWithBuffer(
                            const uint8_t *const buffer,
                            size_t size,
                            const std::map<std::string, std::string> &defaults);
 
                private:
                        using PropertiesMap = std::map<std::string, std::string>;
 
                        PropertiesMap _properties;
                        
                        IO::Mode _mode;
 
                        void
                        registerDefaults(
                            const PropertiesMap &defaults);
                };
        }
}
#endif  /* __BE_IO_PROPERTIES_H__ */