DataContainer.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_DATACONTAINER_H
#define STROMX_RUNTIME_DATACONTAINER_H

#include "stromx/runtime/Config.h"

#ifdef __GNUG__
    #include <tr1/memory>
#else
    #include <memory>
#endif

namespace stromx
{
    namespace runtime
    {
        class Data;
        
        namespace impl
        {
            class ReadAccessImpl;
            class WriteAccessImpl;
            class DataContainerImpl;
            class RecycleAccessImpl;
        }
        
        class STROMX_RUNTIME_API DataContainer
        {
            friend class impl::WriteAccessImpl;
            friend class impl::ReadAccessImpl;
            friend class impl::RecycleAccessImpl;
            
            friend STROMX_RUNTIME_API bool operator==(const DataContainer & lhs, const DataContainer & rhs); 
            friend STROMX_RUNTIME_API bool operator!=(const DataContainer & lhs, const DataContainer & rhs); 
            friend STROMX_RUNTIME_API std::ostream& operator<< (std::ostream& out, const DataContainer & container);
            
        public:
            DataContainer() {}
            
            explicit DataContainer(runtime::Data* data);
            
            explicit DataContainer(runtime::Data* data, const bool isReadOnly);
            
            bool empty() const { return m_impl.get() == 0; }
            
            void release() { m_impl.reset(); }
            
            bool isReadOnly() const;
            
        private:
            std::tr1::shared_ptr<impl::DataContainerImpl> m_impl;
        };     
        
        STROMX_RUNTIME_API bool operator==(const DataContainer & lhs, const DataContainer & rhs); 
        
        STROMX_RUNTIME_API bool operator!=(const DataContainer & lhs, const DataContainer & rhs); 
        
        STROMX_RUNTIME_API std::ostream& operator<< (std::ostream& out, const DataContainer & container);
    }
}

#endif // STROMX_RUNTIME_DATACONTAINER_H