Container.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#ifndef AGX_CONTAINER_H
#define AGX_CONTAINER_H
 
#include <agx/macros.h>
#include <agx/agxCore_export.h>
 
namespace agxData { class Buffer; }
 
namespace agx
{
  class ThreadScopeAllocator;
 
 
  class AGXCORE_EXPORT Container
  {
  public:
 
    enum ClearPolicy
    {
      SHRINK_BUFFER,           
      SHRINK_BUFFER_AVERAGED,  
      MAINTAIN_BUFFER          
    };
 
  public:
 
    size_t size() const;
 
    size_t capacity() const;
 
    bool empty() const;
 
    void* ptr();
    const void* ptr() const;
 
 
  public:
 
    DOXYGEN_START_INTERNAL_BLOCK()
 
    
    void _setBuffer(void* buffer) { m_buffer = buffer; }
    void _setCapacity(size_t capacity) { m_capacity = capacity; }
    void _setSize(size_t size) { m_size = size; }
    DOXYGEN_END_INTERNAL_BLOCK()
 
  protected:
    Container();
    Container(Container&& other);
    Container(const Container& other);
    ~Container();
 
  protected:
    friend class agxData::Buffer;
    friend class Thread;
    size_t m_size;
    size_t m_capacity;
    void* m_buffer;
  };
 
 
 
  /* Implementation */
  AGX_FORCE_INLINE Container::Container() : m_size(0), m_capacity(0), m_buffer(nullptr) {}
  AGX_FORCE_INLINE Container::Container(const Container& other)
    : m_size(0), m_capacity(0), m_buffer(nullptr)
  {
    m_size = other.m_size;
    m_buffer = other.m_buffer;
    m_capacity = other.m_capacity;
  }
 
  AGX_FORCE_INLINE Container::Container(Container&& other):
    m_size(0),
    m_capacity(0),
    m_buffer(nullptr)
  {
    // Move values
    m_buffer = other.m_buffer;
    m_capacity = other.m_capacity;
    m_size = other.m_size;
 
    // Set default values to the rvalue reference.
    other.m_buffer = nullptr;
    other.m_capacity = 0;
    other.m_size = 0;
  }
 
  AGX_FORCE_INLINE Container::~Container()
  {
    m_buffer = nullptr;
    m_size = 0;
    m_capacity = 0;
  }
 
  AGX_FORCE_INLINE size_t Container::size() const { return m_size; }
  AGX_FORCE_INLINE size_t Container::capacity() const { return m_capacity; }
  AGX_FORCE_INLINE bool Container::empty() const { return m_size == 0; }
  AGX_FORCE_INLINE void *Container::ptr() { return m_buffer; }
  AGX_FORCE_INLINE const void *Container::ptr() const { return m_buffer; }
}
 
 
#endif /* _AGX_CONTAINER_H_ */