server/layout.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 EQSERVER_LAYOUT_H
#define EQSERVER_LAYOUT_H

#include "visitorResult.h" // enum
#include "types.h"

#include <eq/client/layout.h> // base class
#include <string>

namespace eq
{
namespace server
{
    class LayoutVisitor;
    class ConstLayoutVisitor;
    struct LayoutPath;
    struct ViewPath;

    class Layout : public eq::Object
    {
    public:
        EQSERVER_EXPORT Layout();

        Layout( const Layout& from, Config* config );

        virtual ~Layout();

        EQSERVER_EXPORT void addView( View* view );
        
        bool removeView( View* view );
        
        const ViewVector& getViews() const { return _views; }

        View* findView( const std::string& name );

        Config* getConfig() { return _config; }
        const Config* getConfig() const { return _config; }

        View* getView( const ViewPath& path );

        LayoutPath getPath() const;

        VisitorResult accept( LayoutVisitor& visitor );
        VisitorResult accept( ConstLayoutVisitor& visitor ) const;

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

    private:
        virtual void getInstanceData( net::DataOStream& os );

        Config* _config;
        friend class Config;

        ViewVector _views;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };
    };

    std::ostream& operator << ( std::ostream& os, const Layout* layout);
}
}
#endif // EQSERVER_LAYOUT_H