VariantInterface.h

/* 
 *  Copyright 2015 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_VARIANTINTERFACE_H
#define STROMX_RUNTIME_VARIANTINTERFACE_H

#include "stromx/runtime/Config.h"

#include <ostream>

namespace stromx
{
    namespace runtime
    {
        class VariantHandle;
        
        class STROMX_RUNTIME_API VariantInterface
        {            
        public:
            enum CompositeType
            {
                NO_COMPOSITE,
                AND_COMPOSITE,
                OR_COMPOSITE
            };
            
            virtual unsigned int id() const = 0;
            
            virtual const std::string & package() const = 0;
            
            virtual const std::string title() const = 0;
            
            virtual bool isVariant(const VariantInterface& variant) const = 0;
            
            virtual CompositeType compositeType() const { return NO_COMPOSITE; }
            
            virtual const VariantHandle lhs() const;
            
            virtual const VariantHandle rhs() const;
        };
        
        STROMX_RUNTIME_API bool operator==(const VariantInterface & lhs, const VariantInterface & rhs);
        STROMX_RUNTIME_API std::ostream& operator<< (std::ostream& out, const VariantInterface & container);
    }
}

#endif // STROMX_RUNTIME_VARIANTINTERFACE_H