CLMemoryAssistant.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/CLMemoryAssistant.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/CLDeviceContext.h>
#include <ICLUtils/CLMemory.h>
#include <ICLUtils/CLBuffer.h>
#include <ICLUtils/CLImage2D.h>
#include <ICLUtils/Exception.h>
#include <map>

namespace icl {
        namespace utils {

                class ICLUtils_API CLMemoryAssistant {

                public:
                        CLMemoryAssistant();

                        CLMemoryAssistant(std::string const &deviceType) ;

                        ~CLMemoryAssistant();

                        typedef std::string MemKeyType;
                        typedef std::map<MemKeyType,CLMemory*> CLMemoryMap;

                        CLBuffer createNamedBuffer(MemKeyType const &key, const string &accessMode,
                                                                           const size_t length, const size_t byteDepth, const void *src=0)
                        ;

                        CLImage2D createNamedImage2D(MemKeyType const &key, const string &accessMode,
                                                                                 const size_t width, const size_t height, const int depth,
                                                                                 const int num_channel, const void *src=0)
                        ;

                        CLMemory *operator[](MemKeyType const &key) ;

                        CLBuffer &asBuf(MemKeyType const &key) ;

                        CLImage2D &asImg(MemKeyType const &key) ;

                        bool keyExist(MemKeyType const &key) { return (bool)m_memory_map.count(key); }

                        void clearAll();

                        void remove(MemKeyType const &key);

                        CLDeviceContext const &getDeviceContext() { return m_context; }

                protected:

                        CLDeviceContext m_context;
                        CLMemoryMap m_memory_map;
                };

        }
}

#endif