client/object.h

/* Copyright (c) 2009, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * 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 EQ_OBJECT_H
#define EQ_OBJECT_H

#include <eq/net/object.h>        // base class

namespace eq
{
    class Object : public net::Object
    {
    public:
        EQ_EXPORT Object();
        
        EQ_EXPORT virtual ~Object();

        EQ_EXPORT void setName( const std::string& name );

        EQ_EXPORT const std::string& getName() const;

        EQ_EXPORT uint64_t getDirty() const { return _dirty; }

    protected:
        virtual bool isDirty() const { return ( _dirty != DIRTY_NONE ); }

        EQ_EXPORT virtual void serialize( net::DataOStream& os,
                                          const uint64_t dirtyBits );

        EQ_EXPORT virtual void deserialize( net::DataIStream& is, 
                                            const uint64_t dirtyBits );

        virtual ChangeType getChangeType() const { return UNBUFFERED; }

        enum DirtyBits
        {
            DIRTY_NONE       = 0,
            DIRTY_NAME       = 1 << 0,
            DIRTY_FILL1      = 1 << 1, // Leave room for binary-compatible patch
            DIRTY_FILL2      = 1 << 2,
            DIRTY_CUSTOM     = 1 << 3,
            DIRTY_ALL        = 0xffffffffffffffffull
        };

        EQ_EXPORT void setDirty( const uint64_t bits );

        EQ_EXPORT virtual void attachToSession( const uint32_t id, 
                                                const uint32_t instanceID, 
                                                net::Session* session );

    private:
        EQ_EXPORT virtual void getInstanceData( net::DataOStream& os );
        EQ_EXPORT virtual void pack( net::DataOStream& os );
        EQ_EXPORT virtual void applyInstanceData( net::DataIStream& is );

        uint64_t _dirty;

        std::string _name;

        union // placeholder for binary-compatible changes
        {
            char dummy[8];
        };
    };
}
#endif // EQ_OBJECT_H