ArrayGetter.hpp

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

#ifndef __FWDATATOOLS_HELPER_ARRAYGETTER_HPP__
#define __FWDATATOOLS_HELPER_ARRAYGETTER_HPP__

#include "fwDataTools/config.hpp"

#include <fwData/Array.hpp>

#include <fwMemory/BufferObject.hpp>

#include <fwTools/Type.hpp>

namespace fwDataTools
{

namespace helper
{

class FWDATATOOLS_CLASS_API ArrayGetter
{

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

    FWDATATOOLS_API ArrayGetter( ::fwData::Array::csptr array );

    FWDATATOOLS_API virtual ~ArrayGetter();


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

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

    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 const void* getBuffer() const;

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

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

    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:

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

};

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

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

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

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

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

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

} // namespace helper

} // namespace fwData

#endif // __FWDATATOOLS_HELPER_ARRAYGETTER_HPP__