BinarySerializerCodec.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_BINARYSERIALIZERCODEC_H_
#define _MIRA_BINARYSERIALIZERCODEC_H_

#ifndef Q_MOC_RUN
#include <boost/shared_ptr.hpp>
#endif

#include <factory/Factory.h>
#include <platform/Typename.h>
#include <utils/Buffer.h>
#include <utils/TypedVoidPtr.h>

namespace mira {


class BinarySerializerCodec;

typedef boost::shared_ptr<BinarySerializerCodec> BinarySerializerCodecPtr;


class MIRA_BASE_EXPORT BinarySerializerCodec : public Object
{
MIRA_ABSTRACT_OBJECT(BinarySerializerCodec)
public:

    struct Fourcc
    {
        Fourcc(const std::string& iFourcc="NULL")
        {
            std::size_t l = std::min<std::size_t>(iFourcc.size(),4);
            for(std::size_t i=0; i<l; ++i)
                fourcc[i] = iFourcc[i];
            for(std::size_t i=l; i<4; ++i)
                fourcc[i] = '\0';
        }

        Fourcc(uint32 val) : value(val) {}

        template<typename Reflector>
        void reflect(Reflector& r) {
            r.member("Value", value, "The 32bit value of the fourcc code");
        }

        static Fourcc null() {
            return Fourcc("NULL");
        }

        bool operator==(Fourcc other) const {
            return value==other.value;
        }

        bool operator!=(Fourcc other) const {
            return !operator==(other);
        }

        bool operator<(Fourcc other) const {
            return value < other.value;
        }

        std::string string() const {
            return std::string(fourcc,4);
        }

    public:
        union {
            char   fourcc[4];
            uint32 value; // as 32bit value
        };
    };

    static_assert(sizeof(Fourcc)==4, "Fourcc must have a size of 4 bytes");

public:

    virtual ~BinarySerializerCodec() {}

        template<typename Reflector>
        void reflect(Reflector& r) {
            r.itemName(this->getClass().getName());
        }

public:

    virtual Fourcc getFourcc() const {
        std::string s = this->getClass().getMetaInfo("FOURCC");
        return Fourcc(s);
    }

    virtual TypeId getSupportedTypeId() const = 0;

public:

    template <typename T>
    Buffer<uint8> encode(const T& object) {
        // these methods pass the typed objects through the untyped
        // encode methods below.
        return std::move(encodeBuffer(&object));
    }

    template <typename T>
    void decode(const Buffer<uint8>& data, T& ioObject) {
        decodeBuffer(data, &ioObject);
    }

protected:

    virtual Buffer<uint8> encodeBuffer(TypedVoidConstPtr objectPtr) = 0;

    virtual void decodeBuffer(const Buffer<uint8>& data, TypedVoidPtr ioObjectPtr) = 0;


public:

    template <typename T>
    static BinarySerializerCodecPtr createCodec(Fourcc fourcc) {

        BinarySerializerCodecPtr codec = createCodec(typeId<T>(), fourcc);
        if(!codec)
            MIRA_THROW(XInvalidParameter, "No codec found for fourcc '" <<
                      fourcc.string() << "' and type '" << typeName<T>() <<"'");
        return codec;
    }

private:

    static BinarySerializerCodecPtr createCodec(TypeId type, Fourcc fourcc);

};


} // namespace

#endif