equalizer.h

/* Copyright (c) 2008-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 EQS_EQUALIZER_H
#define EQS_EQUALIZER_H

#include "../compoundListener.h" // base class
#include "../types.h"

namespace eq
{
namespace server
{
    class Equalizer : protected CompoundListener
    {
    public:
        Equalizer();
        Equalizer( const Equalizer& from );
        virtual ~Equalizer();

        virtual Equalizer* clone() const = 0;

        virtual void toStream( std::ostream& os ) const = 0;

        const Compound* getCompound() const { return _compound; }
        Compound* getCompound()             { return _compound; }

        const Config* getConfig() const;

        virtual void attach( Compound* compound );

        void setFrozen( const bool onOff ) { _frozen = onOff; }
        bool isFrozen() const { return _frozen; }

    private:
        // override in sub-classes to handle dynamic compounds.
        virtual void notifyChildAdded( Compound* compound, Compound* child )
            { EQUNIMPLEMENTED }
        virtual void notifyChildRemove( Compound* compound, Compound* child )
            { EQUNIMPLEMENTED }

        Compound* _compound;       
        bool      _frozen;
    };

    inline std::ostream& operator << ( std::ostream& os, const Equalizer* eq )
    {
        if( eq )
            eq->toStream( os );
        return os;
    }
}
}

#endif // EQS_EQUALIZER_H