BulkDataScopedLock.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ArrayView.h"
#include "Containers/ContainersFwd.h"
#include "Serialization/BulkData.h"
 
// Note that these lock structures only work with the templated versions of FBulkData, such as
// FByteBulkData or FFloatBulkData because they need to know the format of the bulkdata payload
// which the base class FBulkData cannot provide.
 
template<typename ElementType>
class TBulkDataScopedReadLock
{
public:
    UE_NONCOPYABLE(TBulkDataScopedReadLock);
 
    TBulkDataScopedReadLock(const TBulkData<ElementType>& InBulkData)
        : BulkData(InBulkData)
    {
        Data = reinterpret_cast<const ElementType*>(InBulkData.LockReadOnly());
    }
 
    ~TBulkDataScopedReadLock()
    {
        BulkData.Unlock();
    }
 
    int64 Num() const
    {
        return BulkData.GetElementCount();
    }
 
    int64 GetAllocatedSize() const
    {
        return BulkData.GetBulkDataSize();
    }
 
    const ElementType* GetData() const
    {
        return Data;
    }
 
    TConstArrayView64<ElementType> GetView() const
    {
        return TConstArrayView64<ElementType>(Data, Num());
    }
 
private:
    const TBulkData<ElementType>& BulkData;
    const ElementType* Data;
};
 
template<typename ElementType>
class TBulkDataScopedWriteLock
{
public:
    UE_NONCOPYABLE(TBulkDataScopedWriteLock);
 
    TBulkDataScopedWriteLock(TBulkData<ElementType>& InBulkData)
        : BulkData(InBulkData)
    {
        Data = reinterpret_cast<ElementType*>(InBulkData.Lock(LOCK_READ_WRITE));
    }
 
    ~TBulkDataScopedWriteLock()
    {
        BulkData.Unlock();
    }
 
    int64 Num() const
    {
        return BulkData.GetElementCount();
    }
 
    int64 GetAllocatedSize() const
    {
        return BulkData.GetBulkDataSize();
    }
 
    ElementType* GetData() const
    {
        return Data;
    }
 
    TArrayView64<ElementType> GetView() const
    {
        return TArrayView64<ElementType>(Data, Num());
    }
 
private:
 
    TBulkData<ElementType>& BulkData;
    ElementType* Data;
};