collection.h

Go to the documentation of this file.

/*
* Copyright 2015 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.
*/


#ifndef Navigation_Collection_H
#define Navigation_Collection_H

#include "gwnavruntime/containers/kyarray.h"
#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/kernel/SF_RefCount.h"
#include "gwnavruntime/kernel/SF_Debug.h"

namespace Kaim
{

template <typename T>
class CollectionIndexTracker_None;

template <typename T>
class CollectionIndexTrackerPtr;

template <class T, typename CollectionIndexTracker, int SID>
class CollectionImpl;

static const KyUInt32 CollectionInvalidIndex = KyUInt32MAXVAL;

template <class T, int SID = Stat_Default_Mem>
class Collection
{
    KY_DEFINE_NEW_DELETE_OPERATORS(SID)
public:
    // ---------------------------------- Public Member Functions ----------------------------------

    T& PushBack(const T& value);
    T& PushBack();

    T& PushBackUnique(const T& value);

    void Clear();
    void ClearAndReleaseMemory();
    void Reserve(KyUInt32 size);

    KyUInt32 GetCount()    const;
    KyUInt32 GetCapacity() const;
    bool IsEmpty()         const;

    const T& operator[](KyUInt32 index) const;
          T& operator[](KyUInt32 index)      ;

    const T* GetDataPtr() const;
          T* GetDataPtr();

    KyUInt32 RemoveAt(KyUInt32 index);

    KyUInt32 FindFirstOccurrence(const T& value, KyUInt32 startIndex = 0);
    KyUInt32 RemoveFirstOccurrence(const T& value, KyUInt32 startIndex = 0);
    bool DoesContain(const T& value) const;

public: // internal
    CollectionImpl<T, CollectionIndexTracker_None<T>, SID> m_collectionImpl;
};


template <class T, int SID = Stat_Default_Mem>
class TrackedCollection
{
    KY_DEFINE_NEW_DELETE_OPERATORS(SID)
public:
    // ---------------------------------- Public Member Functions ----------------------------------

    T& PushBack(const T& value);
    T& PushBack();

    T& PushBackUnique(const T& value);

    void Clear();
    void ClearAndReleaseMemory();
    void Reserve(KyUInt32 size);

    KyUInt32 GetCount()    const;
    KyUInt32 GetCapacity() const;
    bool IsEmpty()         const;

    const T& operator[](KyUInt32 index) const;
          T& operator[](KyUInt32 index)      ;

    const T* GetDataPtr() const;
          T* GetDataPtr();

    KyUInt32 RemoveAt(KyUInt32 index);

    KyUInt32 FindFirstOccurrence(const T& value, KyUInt32 startIndex = 0);
    KyUInt32 RemoveFirstOccurrence(const T& value, KyUInt32 startIndex = 0);
    bool DoesContain(const T& value) const;

    KyUInt32 Remove(const T& value);

public: // internal
    CollectionImpl<T, CollectionIndexTrackerPtr<T>, SID> m_collectionImpl;
};


} // namespace Kaim

#include "gwnavruntime/containers/collection.inl"

#endif