Connector.h

/* 
*  Copyright 2011 Matthias Fuchs
*
*  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_CONNECTOR_H
#define STROMX_RUNTIME_CONNECTOR_H

#include "stromx/runtime/Config.h"

namespace stromx
{
    namespace runtime
    {
        class Operator;
        
        class Connector
        {
            friend STROMX_RUNTIME_API bool operator==(const Connector & lhs, const Connector & rhs);
            
        public:
            enum Type
            {
                UNDEFINED,
                INPUT,
                OUTPUT
            };
            
            Connector()
              : m_type(UNDEFINED),
                m_op(0),
                m_id(0)
            {}
            
            const Operator* op() const { return m_op; }
            
            unsigned int id() const { return m_id; }
            
            bool valid() const { return m_op != 0; }
            
            Type type() const { return m_type; }
            
        protected:
            explicit Connector(const Type type, const Operator* const op, const unsigned int id)
              : m_type(type),
                m_op(op),
                m_id(id)
            {}
            
        private:
            Type m_type;
            const Operator* m_op;
            unsigned int m_id;
        };
        
        STROMX_RUNTIME_API bool operator==(const Connector & lhs, const Connector & rhs);
    }
}

#endif // STROMX_RUNTIME_CONNECTOR_H