juce::CopyableHeapBlock< ElementType, throwOnFailure > Class Template Reference

Wraps a HeapBlock, but additionally provides a copy constructor and remembers its size. More...

#include <juce_CopyableHeapBlock.h>

Inheritance diagram for juce::CopyableHeapBlock< ElementType, throwOnFailure >:

Collaboration diagram for juce::CopyableHeapBlock< ElementType, throwOnFailure >:

Public Member Functions
	CopyableHeapBlock ()=default
	Creates an empty block.
	CopyableHeapBlock (const CopyableHeapBlock &other)
	Copies the contents of another block into this one.
	CopyableHeapBlock (CopyableHeapBlock &&other) noexcept
	Moves the contents of another block into this one.
	CopyableHeapBlock (size_t numElementsIn)
	Creates a block large enough to hold the specified number of elements.
ElementType *	begin ()
	Returns a pointer to the first element in the block.
const ElementType *	begin () const
	Returns a pointer to the first element in the block.
const ElementType *	cbegin () const
	Returns a pointer to the first element in the block.
const ElementType *	cend () const
	Returns a pointer immediately after the last element in the block.
ElementType *	data ()
	Returns a pointer to the first element in the block.
const ElementType *	data () const
	Returns a pointer to the first element in the block.
ElementType *	end ()
	Returns a pointer immediately after the last element in the block.
const ElementType *	end () const
	Returns a pointer immediately after the last element in the block.
bool	isEmpty () const
	Returns true if the size of the block is zero.
CopyableHeapBlock &	operator= (const CopyableHeapBlock &other) noexcept
	Copies the contents of another block into this one.
CopyableHeapBlock &	operator= (CopyableHeapBlock &&other) noexcept
	Moves the contents of another block into this one.
ElementType &	operator[] (size_t index)
	Returns a reference to the element at the provided index.
const ElementType &	operator[] (size_t index) const
	Returns a reference to the element at the provided index.
size_t	size () const
	Returns the number of elements in the block.

Private Member Functions
void	swap (CopyableHeapBlock &other) noexcept

Private Attributes
HeapBlock< ElementType, throwOnFailure >	block
size_t	numElements {}

Detailed Description

template<typename ElementType, bool throwOnFailure = false>
class juce::CopyableHeapBlock< ElementType, throwOnFailure >

Wraps a HeapBlock, but additionally provides a copy constructor and remembers its size.

This class is not intended for use as a general-purpose container - in most cases, a std::vector or juce::Array is a better choice. However, CopyableHeapBlock may be handy for optimisation in situations where the container elements don't need to be value-initialised and the container doesn't need to be resized.

See also

Array, OwnedArray, MemoryBlock, HeapBlock

@tags{Core}

Constructor & Destructor Documentation

CopyableHeapBlock() [1/4]

template<typename ElementType , bool throwOnFailure = false>

juce::CopyableHeapBlock< ElementType, throwOnFailure >::CopyableHeapBlock ( )

default

Creates an empty block.

CopyableHeapBlock() [2/4]

template<typename ElementType , bool throwOnFailure = false>

juce::CopyableHeapBlock< ElementType, throwOnFailure >::CopyableHeapBlock ( size_t  numElementsIn )

inlineexplicit

Creates a block large enough to hold the specified number of elements.

The contents of the block are unspecified, and must be written before they are first read.

CopyableHeapBlock() [3/4]

template<typename ElementType , bool throwOnFailure = false>

juce::CopyableHeapBlock< ElementType, throwOnFailure >::CopyableHeapBlock ( CopyableHeapBlock< ElementType, throwOnFailure > &&  other )

inlinenoexcept

Moves the contents of another block into this one.

CopyableHeapBlock() [4/4]

template<typename ElementType , bool throwOnFailure = false>

juce::CopyableHeapBlock< ElementType, throwOnFailure >::CopyableHeapBlock ( const CopyableHeapBlock< ElementType, throwOnFailure > &  other )

inline

Copies the contents of another block into this one.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::block, and juce::CopyableHeapBlock< ElementType, throwOnFailure >::numElements.

Member Function Documentation

begin() [1/2]

template<typename ElementType , bool throwOnFailure = false>

ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::begin ( )

inline

Returns a pointer to the first element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data().

begin() [2/2]

template<typename ElementType , bool throwOnFailure = false>

const ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::begin ( ) const

inline

Returns a pointer to the first element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data().

cbegin()

template<typename ElementType , bool throwOnFailure = false>

const ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::cbegin ( ) const

inline

Returns a pointer to the first element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data().

cend()

template<typename ElementType , bool throwOnFailure = false>

const ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::cend ( ) const

inline

Returns a pointer immediately after the last element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::size().

data() [1/2]

template<typename ElementType , bool throwOnFailure = false>

ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::data ( )

inline

Returns a pointer to the first element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::block.

Referenced by juce::CopyableHeapBlock< ElementType, throwOnFailure >::begin(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::begin(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::cbegin(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::cend(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::end(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::end(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator[](), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator[]().

data() [2/2]

template<typename ElementType , bool throwOnFailure = false>

const ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::data ( ) const

inline

Returns a pointer to the first element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::block.

end() [1/2]

template<typename ElementType , bool throwOnFailure = false>

ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::end ( )

inline

Returns a pointer immediately after the last element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::size().

end() [2/2]

template<typename ElementType , bool throwOnFailure = false>

const ElementType * juce::CopyableHeapBlock< ElementType, throwOnFailure >::end ( ) const

inline

Returns a pointer immediately after the last element in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::size().

isEmpty()

template<typename ElementType , bool throwOnFailure = false>

bool juce::CopyableHeapBlock< ElementType, throwOnFailure >::isEmpty ( ) const

inline

Returns true if the size of the block is zero.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::size().

operator=() [1/2]

template<typename ElementType , bool throwOnFailure = false>

CopyableHeapBlock & juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator= ( const CopyableHeapBlock< ElementType, throwOnFailure > &  other )

inlinenoexcept

Copies the contents of another block into this one.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::swap().

operator=() [2/2]

template<typename ElementType , bool throwOnFailure = false>

CopyableHeapBlock & juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator= ( CopyableHeapBlock< ElementType, throwOnFailure > &&  other )

inlinenoexcept

Moves the contents of another block into this one.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::swap().

operator[]() [1/2]

template<typename ElementType , bool throwOnFailure = false>

ElementType & juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator[] ( size_t  index )

inline

Returns a reference to the element at the provided index.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data().

operator[]() [2/2]

template<typename ElementType , bool throwOnFailure = false>

const ElementType & juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator[] ( size_t  index ) const

inline

Returns a reference to the element at the provided index.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::data().

size()

template<typename ElementType , bool throwOnFailure = false>

size_t juce::CopyableHeapBlock< ElementType, throwOnFailure >::size ( ) const

inline

Returns the number of elements in the block.

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::numElements.

Referenced by juce::CopyableHeapBlock< ElementType, throwOnFailure >::cend(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::end(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::end(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::isEmpty().

swap()

template<typename ElementType , bool throwOnFailure = false>

void juce::CopyableHeapBlock< ElementType, throwOnFailure >::swap ( CopyableHeapBlock< ElementType, throwOnFailure > &  other )

inlineprivatenoexcept

References juce::CopyableHeapBlock< ElementType, throwOnFailure >::block, and juce::CopyableHeapBlock< ElementType, throwOnFailure >::numElements.

Referenced by juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator=(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::operator=().

Member Data Documentation

block

template<typename ElementType , bool throwOnFailure = false>

HeapBlock<ElementType, throwOnFailure> juce::CopyableHeapBlock< ElementType, throwOnFailure >::block

private

Referenced by juce::CopyableHeapBlock< ElementType, throwOnFailure >::CopyableHeapBlock(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::data(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::data(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::swap().

numElements

template<typename ElementType , bool throwOnFailure = false>

size_t juce::CopyableHeapBlock< ElementType, throwOnFailure >::numElements {}

private

Referenced by juce::CopyableHeapBlock< ElementType, throwOnFailure >::CopyableHeapBlock(), juce::CopyableHeapBlock< ElementType, throwOnFailure >::size(), and juce::CopyableHeapBlock< ElementType, throwOnFailure >::swap().

---

The documentation for this class was generated from the following file:

• juce_CopyableHeapBlock.h