CLMemory.h

Go to the documentation of this file.

/********************************************************************
 **                Image Component Library (ICL)                    **
 **                                                                 **
 ** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
 **                         Neuroinformatics Group                  **
 ** Website: www.iclcv.org and                                      **
 **          http://opensource.cit-ec.de/projects/icl               **
 **                                                                 **
 ** File   : ICLUtils/src/ICLUtils/CLMemory.h                       **
 ** Module : ICLUtils                                               **
 ** Authors: Tobias Roehlig                                         **
 **                                                                 **
 **                                                                 **
 ** GNU LESSER GENERAL PUBLIC LICENSE                               **
 ** This file may be used under the terms of the GNU Lesser General **
 ** Public License version 3.0 as published by the                  **
 **                                                                 **
 ** Free Software Foundation and appearing in the file LICENSE.GPL  **
 ** included in the packaging of this file.  Please review the      **
 ** following information to ensure the license requirements will   **
 ** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
 **                                                                 **
 ** The development of this software was supported by the           **
 ** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
 ** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
 ** Forschungsgemeinschaft (DFG) in the context of the German       **
 ** Excellence Initiative.                                          **
 **                                                                 **
 ********************************************************************/

#pragma once

#ifdef ICL_HAVE_OPENCL

#include <ICLUtils/SmartPtr.h>
#include <ICLUtils/CLException.h>
#include <vector>

namespace icl {
        namespace utils {

                class CLBuffer;
                class CLImage2D;

                class ICLUtils_API CLMemory {

                public:

                        typedef SmartPtr<CLMemory> Ptr;

                        enum MemoryType {
                                Buffer,
                                Image2D,
                                Invalid
                        };

                protected:

                        CLMemory(MemoryType const type = Invalid) : m_dimensions(3,1), m_size(1), m_type(type) {}

                        std::vector<icl32s> m_dimensions;
                        icl64s m_size;
                        icl32s m_byte_depth;

                        void setDimensions(icl32s const &x, icl32s const &y, icl32s const &z) {
                                m_dimensions[0] = x; m_dimensions[1] = y; m_dimensions[2] = z;
                                m_size = x*y*z;
                        }

                private:

                        MemoryType m_type;

                public:

                        CLMemory(CLMemory const &other) {
                                this->m_type = other.m_type;
                                this->m_dimensions = other.m_dimensions;
                                this->m_size = other.m_size;
                                this->m_byte_depth = other.m_byte_depth;
                        }

                        CLMemory& operator=(CLMemory const& other) {
                                this->m_type = other.m_type;
                                this->m_dimensions = other.m_dimensions;
                                this->m_size = other.m_size;
                                this->m_byte_depth = other.m_byte_depth;
                                return *this;
                        }

                        virtual ~CLMemory() {}

                        inline CLBuffer *asCLBuffer() {
                                if (m_type != Buffer)
                                        throw CLBufferException("Invalid cast from CLMemory to CLBuffer pointer");
                                return reinterpret_cast<CLBuffer*>(this);
                        }

                        inline CLImage2D *asCLImage2D() {
                                if (m_type != Image2D)
                                        throw CLBufferException("Invalid cast from CLMemory to CLImage2D pointer");
                                return reinterpret_cast<CLImage2D*>(this);
                        }

                        const std::vector<icl32s> getDimensions() const { return m_dimensions; }
                        const icl64s getSize() const { return m_size; }
                        const icl32s getByteDepth() const { return m_byte_depth; }

                };

        }
}

#endif