omni::serialization::PropertyMap Class Reference

Property map to store properties in a QBuffer with an id. More...

#include <PropertyMap.h>

Inheritance diagram for omni::serialization::PropertyMap:

Collaboration diagram for omni::serialization::PropertyMap:

Public Member Functions
	PropertyMap ()
	PropertyMap (QDataStream &)
	Construct from stream. More...
template<typename T , typename... ARGS>
PropertyMap &	put (QString const &_id, T const &_t, ARGS &&..._args)
	Put an object of type T with id into property map. More...
template<typename T , typename... ARGS>
PropertyMap const &	get (QString const &_id, T &_t, ARGS &&..._args) const
	Read an object of type T with id from property map. More...
template<typename T , typename... ARGS>
PropertyMap const &	get (QString const &_id, T *_t, ARGS &&..._args) const
	Read an object of type T with id from property map. More...
template<typename T >
T	getValue (QString const &_id, T const &_default=T()) const
	Get value from id (with optional default value when id is not present) More...
template<typename FACTORY_FUNCTOR , typename... ARGS>
PropertyMap const &	getPtr (QString const &_id, FACTORY_FUNCTOR _f, ARGS &&..._args) const
	Read an object of type T with id from property map. More...
template<typename T , typename CLASS , typename MEM_FN >
PropertyMap const &	get (QString const &_id, CLASS &_class, MEM_FN _memFn, T const &_default=T()) const
	Get value from. More...
template<typename T , typename... ARGS>
PropertyMap &	operator() (QString const &_id, T const &_t)
	Write an object into property map. More...
template<typename T >
PropertyMap const &	operator() (QString const &_id, T &_t) const
	Read an object from property map. More...
std::vector< QString >	ids () const
	Return list of ids. More...
void	toStream (QDataStream &) const
	Write property map to stream. More...
void	fromStream (QDataStream &)
	Read property map from stream. More...
Public Member Functions inherited from omni::serialization::Interface
virtual	~Interface ()
virtual bool	equal (Interface const *_that) const
	Optional virtual member method for testing equality of two. More...

Private Types
typedef std::map< QString, QByteArray >	property_map

Static Private Member Functions
static QString	makeChecksum (QByteArray const &_b)
	Make MD5 checksum from byte array. More...
static QString	makeChecksum (QString const &_s)
	Make MD5 checksum from byte array. More...
static QString	makeChecksum (property_map const &_properties)
	Make MD5 checksum from property map. More...

Private Attributes
property_map	properties_

Detailed Description

Property map to store properties in a QBuffer with an id.

Member Typedef Documentation

typedef std::map<QString, QByteArray> omni::serialization::PropertyMap::property_map

private

Constructor & Destructor Documentation

omni::serialization::PropertyMap::PropertyMap

(

)

        {
        }

omni::serialization::PropertyMap::PropertyMap

(

QDataStream &

_stream

)

Construct from stream.

                                                     {
          fromStream(_stream);
        }

Member Function Documentation

void omni::serialization::PropertyMap::fromStream ( QDataStream &  _is )

virtual

Read property map from stream.

Implements omni::serialization::Interface.

                                                     {
            QString _hash;
            deserialize(_is,_hash);
            uint32_t _size = 0;
            _is >> _size;

            for (size_t i = 0; i < _size; ++i) {
                QString _propertyHash;
                QString _propertyId;
                QByteArray _propertyData;
                deserialize(_is,_propertyHash);
                deserialize(_is,_propertyId);
                deserialize(_is,_propertyData);
                properties_[_propertyId] = _propertyData;

                if (_propertyHash != makeChecksum(_propertyData)) {
                    throw exception::ChecksumError(_propertyHash, makeChecksum(
                                                       properties_), _propertyId);
                }
            }

            if (_hash != makeChecksum(properties_)) {
                throw exception::ChecksumError(_hash, makeChecksum(properties_));
            }
        }

template<typename T , typename... ARGS>

PropertyMap const& omni::serialization::PropertyMap::get ( QString const &  _id, T &  _t, ARGS &&...  _args  ) const

inline

Read an object of type T with id from property map.

                                                                                  {
          if (properties_.count(_id) == 0) {
            //throw exception::PropertyNotExisting(_id);
            //return;
            return *this;
          }

          QDataStream _s(properties_.at(_id));
          deserialize(_s, _t, _args ...);
          return *this;
        }

template<typename T , typename... ARGS>

PropertyMap const& omni::serialization::PropertyMap::get ( QString const &  _id, T *  _t, ARGS &&...  _args  ) const

inline

Read an object of type T with id from property map.

                                                                                  {
          if (properties_.count(_id) == 0) {
            //throw exception::PropertyNotExisting(_id);
            return *this;
          }

          QDataStream _s(properties_.at(_id));
          deserialize(_s, _t, _args ...);
          return *this;
        }

template<typename T , typename CLASS , typename MEM_FN >

PropertyMap const& omni::serialization::PropertyMap::get ( QString const &  _id, CLASS &  _class, MEM_FN  _memFn, T const &  _default = T()  ) const

inline

Get value from.

                                                              {
          T _value = _default;

          try {
            get<T>(_id, _value);
            _memFn(_class, _value);
          } catch (exception::PropertyNotExisting& e) {
            return *this;
          }
          return *this;
        }

template<typename FACTORY_FUNCTOR , typename... ARGS>

PropertyMap const& omni::serialization::PropertyMap::getPtr ( QString const &  _id, FACTORY_FUNCTOR  _f, ARGS &&...  _args  ) const

inline

Read an object of type T with id from property map.

                                                          {
          if (properties_.count(_id) == 0) {
            throw exception::PropertyNotExisting(_id);
          }
          QDataStream _s(properties_.at(_id));
          deserializePtr(_s, _f, _args ...);
          return *this;
        }

template<typename T >

T omni::serialization::PropertyMap::getValue ( QString const &  _id, T const &  _default = T()  ) const

inline

Get value from id (with optional default value when id is not present)

                                                                      {
          if (properties_.count(_id) == 0) {
            return _default;
          }
          T _t;
          QDataStream _s(properties_.at(_id));
          deserialize(_s, _t);
          return _t;
        }

std::vector<QString> omni::serialization::PropertyMap::ids ( ) const

inline

Return list of ids.

                                       {
          std::vector<QString> _ids;
          for (auto& _idValue : properties_) {
            _ids.push_back(_idValue.first);
          }
          return _ids;
        }

QString omni::serialization::PropertyMap::makeChecksum ( QByteArray const &  _b )

staticprivate

Make MD5 checksum from byte array.

                                                              {
            return QString(QCryptographicHash::hash(_b,QCryptographicHash::Sha1).toHex());
        }

QString omni::serialization::PropertyMap::makeChecksum ( QString const &  _s )

staticprivate

Make MD5 checksum from byte array.

                                                           {
            return makeChecksum(_s.toLatin1());
        }

QString omni::serialization::PropertyMap::makeChecksum ( property_map const &  _properties )

staticprivate

Make MD5 checksum from property map.

                                                                         {
                QString _merged;
                _merged += QString("%1").arg(_properties.size());
                for (auto& _property : _properties) {
                    _merged += _property.first;
                    _merged += makeChecksum(_property.second);
                }
                return makeChecksum(_merged);
        }

template<typename T , typename... ARGS>

PropertyMap& omni::serialization::PropertyMap::operator() ( QString const &  _id, T const &  _t  )

inline

Write an object into property map.

                                                                 {
          return put(_id, _t);
        }

template<typename T >

PropertyMap const& omni::serialization::PropertyMap::operator() ( QString const &  _id, T &  _t  ) const

inline

Read an object from property map.

                                                                       {
          return get(_id, _t);
        }

template<typename T , typename... ARGS>

PropertyMap& omni::serialization::PropertyMap::put ( QString const &  _id, T const &  _t, ARGS &&...  _args  )

inline

Put an object of type T with id into property map.

                                                                            {
          if (properties_.count(_id) != 0) {
            throw exception::PropertyExisting(_id);
          }
          QBuffer _buf;
          _buf.open(QIODevice::WriteOnly);
          QDataStream _s(&_buf); // ,QIODevice::WriteOnly);
          serialize(_s, _t, _args ...);
          properties_[_id] = _buf.data();
          return *this;
        }

void omni::serialization::PropertyMap::toStream ( QDataStream &  _os ) const

virtual

Write property map to stream.

Implements omni::serialization::Interface.

                                                         {

            serialize(_os,makeChecksum(properties_));
            _os << uint32_t(properties_.size());

            for (auto& _property : properties_) {
                serialize(_os,makeChecksum(_property.second));
                serialize(_os,_property.first);
                serialize(_os,_property.second);
            }
        }

Field Documentation

property_map omni::serialization::PropertyMap::properties_

private

---

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

• include/omni/serialization/PropertyMap.h
• src/lib/serialization/PropertyMap.cpp