objectMap.h

/* Copyright (c) 2012, Daniel Nachbaur <danielnachbaur@googlemail.com>
 *               2012, Stefan Eilemann <eile@eyescale.ch>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef CO_OBJECTMAP_H
#define CO_OBJECTMAP_H

#include <co/serializable.h>      // base class

namespace co
{
namespace detail { class ObjectMap; }

    class ObjectMap : public Serializable
    {
    public:
        CO_API ObjectMap( ObjectHandler& handler, ObjectFactory& factory );

        CO_API virtual ~ObjectMap();

        CO_API bool register_( Object* object, const uint32_t type );

        CO_API Object* get( const uint128_t& identifier, Object* instance=0 );

        CO_API virtual uint128_t commit( const uint32_t incarnation =
                                         CO_COMMIT_NEXT );

    protected:
        CO_API virtual bool isDirty() const;

        CO_API virtual void serialize( DataOStream& os,
                                       const uint64_t dirtyBits );
        CO_API virtual void deserialize( DataIStream& is,
                                         const uint64_t dirtyBits );

        virtual ChangeType getChangeType() const { return DELTA; }

        CO_API virtual void notifyAttached();

        enum DirtyBits
        {
            DIRTY_ADDED       = Serializable::DIRTY_CUSTOM << 0, // 1
            DIRTY_CHANGED     = Serializable::DIRTY_CUSTOM << 1, // 2
            DIRTY_CUSTOM      = Serializable::DIRTY_CUSTOM << 2  // 4
        };        

    private:
        detail::ObjectMap* const _impl;

        void _commitMasters( const uint32_t incarnation );
    };
}
#endif // CO_OBJECTMAP_H