Stream.h

/* 
*  Copyright 2011 Thomas Fidler
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*/

#ifndef STROMX_RUNTIME_STREAM_H
#define STROMX_RUNTIME_STREAM_H

#include <set>
#include <string>
#include <vector>
#include "stromx/runtime/Config.h"
#include "stromx/runtime/ExceptionObserver.h"
#include "stromx/runtime/OutputConnector.h"

namespace stromx
{
    namespace runtime
    {
        class AbstractFactory;
        class Operator;
        class OperatorError;
        class OperatorKernel;
        class Registry;
        class Thread;
        
        namespace impl
        {
            class MutexHandle;
            class Network;
        }
        
        class STROMX_RUNTIME_API Stream
        {
        public:
            enum Status
            {
                INACTIVE,
                ACTIVE,
                DEACTIVATING,
                PAUSED
            };
            
            Stream();
            ~Stream();
            
            const std::string& name() const { return m_name; }
            
            void setName(const std::string& name) { m_name = name; }
            
            Status status() const { return m_status; }
            
            const std::vector<Operator*>& operators() const;     
            
            const std::vector<Operator*>& initializedOperators() const;    
            
            const AbstractFactory* factory() const { return m_factory; }
            
            void setFactory(const AbstractFactory* const factory);      
            
            void connect(Operator* const sourceOp, const unsigned int outputId, 
                         Operator* const targetOp, const unsigned int inputId);
                         
            void disconnect(Operator* const targetOp, const unsigned int inputId);
            
            const OutputConnector connectionSource(const Operator* const targetOp, const unsigned int inputId) const;
            
            Operator* addOperator(OperatorKernel* const op);
            
            void hideOperator(Operator* const op);
            
            void showOperator(Operator* const op);
            
            void removeOperator(Operator* const op);
            
            void initializeOperator(Operator* const op);
            
            void deinitializeOperator(Operator* const op);
            
            void setConnectorType(Operator* const op, const unsigned int id,
                                  const Description::Type type, const Description::UpdateBehavior behavior = Description::PERSISTENT);
            
            Thread* addThread();
            
            void hideThread(Thread* const thread);
            
            void showThread(Thread* const thread);
            
            void removeThread(Thread* const thread);
            
            const std::vector<Thread*> & threads() const;
            
            void addObserver(const ExceptionObserver* const observer);
            
            void removeObserver(const ExceptionObserver* const observer);
            
            unsigned int delay() const;
            
            void setDelay(const unsigned int delay);
            
            void start();
            
            void stop();
            
            void join();
            
            void pause();
            
            void resume();
            
        private:
            class InternalThreadObserver;
            class InternalNetworkObserver;
            
            void observeException(const ExceptionObserver::Phase phase, const OperatorError & ex, const Thread * const thread) const;
            bool isPartOfStream(const Operator* const op) const;
            bool isPartOfStream(const OperatorInfo* const op) const;
            bool isPartOfInitializedStream(const Operator* const op) const;
            bool isPartOfUninitializedStream(const Operator* const op) const;
            void attachOperator(Operator* const op);
            void attachThread(Thread* const thread);
            void detachOperator(Operator* const op);
            void detachThread(Thread* const thread);
            void disconnectInput(Operator* const op, const unsigned int id);
            void disconnectOutput(Operator* const op, const unsigned int id);
            
            std::string m_name; 
            impl::Network* const m_network;
            std::vector<Thread*> m_threads;
            std::set<const ExceptionObserver*> m_observers;
            impl::MutexHandle*  m_observerMutex;
            Status m_status;
            const AbstractFactory* m_factory;
            impl::MutexHandle*  m_delayMutex;
            unsigned int m_delay;
            std::set<Operator*> m_uninitializedOperators;
            std::vector<Operator*> m_operators;
            std::set<Operator*> m_hiddenOperators;
            std::set<Thread*> m_hiddenThreads;
        };
    }
}

#endif // STROMX_RUNTIME_STREAM_H