channelVisitor.h

/* Copyright (c) 2008, Stefan Eilemann <[email protected]> 
   All rights reserved. */

#ifndef EQ_CHANNELVISITOR_H
#define EQ_CHANNELVISITOR_H

#include <iostream>

namespace eq
{
    class Channel;

    class ChannelVisitor
    {
    public:
        ChannelVisitor(){}
        
        virtual ~ChannelVisitor(){}

        enum Result
        {
            TRAVERSE_CONTINUE,   
            TRAVERSE_TERMINATE,  
            TRAVERSE_PRUNE       
        };

        virtual Result visit( Channel* channel )
            { return TRAVERSE_CONTINUE; }
    };

    inline std::ostream& operator << ( std::ostream& os, 
                                       const ChannelVisitor::Result result )
    {
        switch( result )
        {
            case ChannelVisitor::TRAVERSE_CONTINUE:
                os << "continue";
                break;
            case ChannelVisitor::TRAVERSE_TERMINATE:
                os << "terminate";
                break;
            case ChannelVisitor::TRAVERSE_PRUNE:
                os << "prune";
                break;
            default:
                os << "ERROR";
                break;
        }
        return os;
    }
}
#endif // EQ_CHANNELVISITOR_H