ools/include/fwDataTools/helper/Array.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2018.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#pragma once

#include "fwDataTools/config.hpp"

#include <fwData/Array.hpp>

#include <fwMemory/BufferObject.hpp>

namespace fwDataTools
{

namespace helper
{

class FWDATATOOLS_CLASS_API Array
{

public:
    fwCoreClassFactoryMacro((Array), (((::fwData::Array::sptr))), new Array )

    FWDATATOOLS_API Array( ::fwData::Array::sptr array );
    FWDATATOOLS_API virtual ~Array();

    FWDATATOOLS_API virtual void setItem(const ::fwData::Array::IndexType& id, const void* value);

    FWDATATOOLS_API virtual void setItem(const ::fwData::Array::IndexType& id, const size_t component,
                                         const void* value);


    FWDATATOOLS_API virtual void* getItem(const ::fwData::Array::IndexType& id, const size_t component = 0);

    template< typename T > T* getItem(const ::fwData::Array::IndexType& id, const size_t component = 0);

    FWDATATOOLS_API virtual void getItem(const ::fwData::Array::IndexType& id, void* value) const;
    FWDATATOOLS_API virtual void getItem(const ::fwData::Array::IndexType& id, const size_t component,
                                         void* value) const;

    FWDATATOOLS_API virtual void* getBuffer();
    FWDATATOOLS_API virtual const void* getBuffer() const;

    FWDATATOOLS_API void setBuffer(
        void* buf,
        bool takeOwnership,
        const ::fwTools::Type& type,
        const ::fwData::Array::SizeType& size,
        size_t nbOfComponents,
        ::fwMemory::BufferAllocationPolicy::sptr policy = ::fwMemory::BufferMallocPolicy::New()
        );

    FWDATATOOLS_API virtual char* begin();
    FWDATATOOLS_API virtual char* end();
    FWDATATOOLS_API virtual const char* begin() const;
    FWDATATOOLS_API virtual const char* end() const;

    template< typename T > T* begin();
    template< typename T > T* end();

    FWDATATOOLS_API char* getBufferPtr( const ::fwData::Array::IndexType& id, size_t component, size_t sizeOfType );
    FWDATATOOLS_API const char* getBufferPtr( const ::fwData::Array::IndexType& id, size_t component,
                                              size_t sizeOfType ) const;

    FWDATATOOLS_API ::fwMemory::BufferObject::Lock getLock() const;

protected:

    FWDATATOOLS_API virtual void setBuffer(
        void* buf,
        bool takeOwnership                              = false,
        ::fwMemory::BufferAllocationPolicy::sptr policy = ::fwMemory::BufferMallocPolicy::New()
        );

    ::fwData::Array::sptr m_array;
    ::fwMemory::BufferObject::Lock m_lock;

};

//------------------------------------------------------------------------------

template< typename T >
T* Array::begin()
{
    return static_cast<T*>(this->getBuffer());
}

//------------------------------------------------------------------------------

template< typename T >
T* Array::end()
{
    return reinterpret_cast<T*> (static_cast<char*>(this->getBuffer()) + m_array->getSizeInBytes());
}

//------------------------------------------------------------------------------

template< typename T >
T* Array::getItem(const ::fwData::Array::IndexType& id, const size_t component)
{
    return static_cast<T*> (this->getItem(id, component));
}

} // namespace helper

} // namespace fwData