.. index:: pair: class; EE::System::TScopedBuffer
.. _doxid-class_e_e_1_1_system_1_1_t_scoped_buffer:

template class EE::System::TScopedBuffer
========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Keep a pointer to a buffer and release it when the ScopedBuffer goes out of scope. :ref:`More...<details-class_e_e_1_1_system_1_1_t_scoped_buffer>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <scopedbuffer.hpp>
	
	template <typename T>
	class TScopedBuffer: private :ref:`EE::NonCopyable<doxid-class_e_e_1_1_non_copyable>` {
	public:
		// construction
	
		:target:`TScopedBuffer<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a1c4e1ba2cf630a149ae770eb43ad8978>`();
		:target:`TScopedBuffer<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1ae16914240fe79f41d71ce38f1f51c2b2>`(std::size_t length);
		:target:`TScopedBuffer<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1abaa2b48938008beb4c498b02dc823250>`(T* data, std::size_t length);
		:ref:`~TScopedBuffer<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1ac9522d5663a7433fde467ff8da98de08>`();

		// methods
	
		void :target:`clear<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a6dabdbff0d076e21e1a82cb83f4b66ca>`();
		T& :target:`operator[]<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a97a4534e323cd047543eedfac9147dfd>`(std::size_t i) const;
		bool :target:`operator()<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1abadcbed25d64fce561b8d6edcaa99041>`() const;
		T* :target:`get<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1ae4cef896e97b78259bd6cd1073f9211f>`() const;
		void :target:`swap<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a4cc21c859134b3cd6a46d81470772592>`(TScopedBuffer<T>& b);
		void :target:`reset<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a067abc9c1a13bab1024705c6d28a3bb7>`(T* p = 0, const std::size_t& size = 0);
		void :target:`reset<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a2de31ddab77784620d06f243ea576145>`(const std::size_t& size = 0);
		void :ref:`reset<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a30faf2486c89746ee6d92eaca1966ed6>`(const T* p = 0, const std::size_t& size = 0);
		bool :target:`isEmpty<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a845c65168fe11461aab524ebae3bba85>`() const;
		const std::size_t& :target:`size<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1aecc99941dd6f0b48eea8f418f17e9950>`() const;
		const std::size_t& :target:`length<doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1aebf655fd106c50848928ea09803492cd>`() const;
	};
.. _details-class_e_e_1_1_system_1_1_t_scoped_buffer:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Keep a pointer to a buffer and release it when the ScopedBuffer goes out of scope.

The :ref:`TScopedBuffer <doxid-class_e_e_1_1_system_1_1_t_scoped_buffer>` class template stores a pointer to a dynamically allocated array. (Dynamically allocated arrays are allocated with the C++ new[] expression.) The array pointed to is guaranteed to be deleted, either on destruction of the :ref:`TScopedBuffer <doxid-class_e_e_1_1_system_1_1_t_scoped_buffer>`, or via an explicit reset.

The :ref:`TScopedBuffer <doxid-class_e_e_1_1_system_1_1_t_scoped_buffer>` template is a simple solution for simple needs. It supplies a basic "resource acquisition is initialization" facility, without shared-ownership or transfer-of-ownership semantics. Both its name and enforcement of semantics (by being :ref:`NonCopyable <doxid-class_e_e_1_1_non_copyable>`) signal its intent to retain ownership solely within the current scope.

Construction
------------

.. _doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1ac9522d5663a7433fde467ff8da98de08:
.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	~TScopedBuffer()

The destructor deletes the buffer.

Methods
-------

.. index:: pair: function; reset
.. _doxid-class_e_e_1_1_system_1_1_t_scoped_buffer_1a30faf2486c89746ee6d92eaca1966ed6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void reset(const T* p = 0, const std::size_t& size = 0)

creates a copy of p