include/fwData/Array.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 __FWDATA_ARRAY_HPP__
#define __FWDATA_ARRAY_HPP__

#include "fwData/config.hpp"
#include "fwData/Exception.hpp"
#include "fwData/factory/new.hpp"
#include "fwData/Object.hpp"

#include <fwMemory/BufferObject.hpp>

#include <fwTools/Type.hpp>

fwCampAutoDeclareDataMacro((fwData)(Array), FWDATA_API);

namespace fwData
{

class FWDATA_CLASS_API Array : public ::fwData::Object
{
public:

    fwCoreClassDefinitionsWithFactoryMacro( (Array)(::fwData::Object), (()), ::fwData::factory::New< Array >);

    fwCampMakeFriendDataMacro((fwData)(Array));

    typedef std::vector<size_t> SizeType;
    typedef std::vector<size_t> OffsetType;
    typedef OffsetType IndexType;

    /*
     * public API
     */

    FWDATA_API Array( ::fwData::Object::Key key );

    FWDATA_API virtual ~Array();

    FWDATA_API void cachedDeepCopy(const Object::csptr& _source, DeepCopyCacheType& cache) override;

    FWDATA_API virtual size_t resize(const ::fwTools::Type& type, const SizeType& size, size_t nbOfComponents,
                                     bool reallocate = false);

    FWDATA_API virtual size_t resize(const std::string& type, const SizeType& size, size_t nbOfComponents,
                                     bool reallocate = false);
    FWDATA_API virtual size_t resize(const SizeType& size, size_t nbOfComponents, bool reallocate =
                                         false);
    FWDATA_API virtual size_t resize(const SizeType& size, bool reallocate = false);

    FWDATA_API virtual void clear();

    FWDATA_API virtual bool empty() const;

    FWDATA_API virtual size_t getElementSizeInBytes() const;

    FWDATA_API virtual size_t getNumberOfElements() const;

    FWDATA_API virtual size_t getSizeInBytes() const;

    FWDATA_API virtual const SizeType& getSize() const;

    FWDATA_API virtual const OffsetType& getStrides() const;

    FWDATA_API virtual void setNumberOfComponents(size_t nb);

    FWDATA_API virtual size_t getNumberOfComponents() const;

    FWDATA_API virtual size_t getNumberOfDimensions() const;

    FWDATA_API virtual void setIsBufferOwner(const bool own);

    FWDATA_API virtual bool getIsBufferOwner() const;

    FWDATA_API virtual void setType(const std::string& type);
    FWDATA_API virtual void setType(const ::fwTools::Type& type);

    FWDATA_API virtual ::fwTools::Type getType() const;

    FWDATA_API size_t getBufferOffset( const ::fwData::Array::IndexType& id, size_t component,
                                       size_t sizeOfType ) const;

    FWDATA_API static OffsetType computeStrides( SizeType size, size_t nbOfComponents, size_t sizeOfType );

    ::fwMemory::BufferObject::sptr getBufferObject () const;

    void setBufferObject (const ::fwMemory::BufferObject::sptr& val);

    FWDATA_API void swap( Array::sptr _source );

protected:

    Array( const Array& );

    const Array& operator= ( const Array& );

    OffsetType m_strides;
    ::fwTools::Type m_type;
    ::fwMemory::BufferObject::sptr m_bufferObject;
    SizeType m_size;
    size_t m_nbOfComponents;
    bool m_isBufferOwner;

};

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

inline ::fwMemory::BufferObject::sptr Array::getBufferObject () const
{
    return m_bufferObject;
}

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

inline void Array::setBufferObject (const ::fwMemory::BufferObject::sptr& val)
{
    m_bufferObject = val;
}

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

} // namespace fwData

#endif // __FWDATA_ARRAY_HPP__