workingmemarray.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/querysystem/workingmemcontainers/workingmemcontainerbase.h"
#include <string.h>

namespace Kaim
{

template <class T>
class WorkingMemArray
{
public:
    WorkingMemArray() : m_count(0), m_capacity(0) {} // leaves WorkingMemArray uninitialized

    WorkingMemArray(WorkingMemory* workingMemory) { Init(workingMemory); }

    void Init(WorkingMemory* workingMemory);

    bool IsInitialized()   const { return m_buffer.IsInitialized(); }

    T*       GetBuffer()   const { return (T*)m_buffer.GetBuffer(); }
    KyUInt32 GetCount()    const { return m_count; }
    KyUInt32 GetCapacity() const { return m_capacity; }
    bool     IsEmpty()     const { return m_count == 0; }

    void MakeEmpty() { m_count = 0; }
    KyResult SetMinimumCapacity(KyUInt32 capacity); // return KY_ERROR if the working memory reaches its memory limit
    KyResult GrowIfNeeded();                        // return KY_ERROR if the working memory reaches its memory limit

    KyResult PushBack(const T& x);                  // return KY_ERROR if the working memory reaches its memory limit
    void PushBack_UnSafe(const T& x);

    KyResult PopBack();

    const T& operator[](UPInt idx) const;
    T& operator[](UPInt idx);

    void ReleaseWorkingMemoryBuffer() { m_buffer.ReleaseBuffer(); }

private:
    // capacity == 0 means increase capacity by the underlying working mem granularity
    bool TryToResize(KyUInt32 capacity = 0);

public:
    WorkingMemContainerBase m_buffer;
    KyUInt32 m_count;
    KyUInt32 m_capacity;
};

}

#include "gwnavruntime/querysystem/workingmemcontainers/workingmemarray.inl"