catapult::model::BasicContiguousEntityContainer< TEntity > Class Template Reference

Collaboration diagram for catapult::model::BasicContiguousEntityContainer< TEntity >:

Classes
class	iterator
	Actual iterator. More...
struct	State

Public Types
using	value_type = TEntity

Public Member Functions
constexpr	BasicContiguousEntityContainer (TEntity *pEntity, size_t entitiesSize, EntityContainerErrorPolicy errorPolicy)
auto	cbegin () const
	Returns a const iterator that represents the first entity. More...
auto	cend () const
	Returns a const iterator that represents one past the last entity. More...
auto	begin () const
	Returns an iterator that represents the first entity. More...
auto	end () const
	Returns an iterator that represents one past the last entity. More...
bool	hasError () const
	Gets a value indicating whether or not there was an iteration error. More...

Private Attributes
TEntity *	m_pStart
State	m_state

Detailed Description

template<typename TEntity>
class catapult::model::BasicContiguousEntityContainer< TEntity >

Container wrapper around contiguous memory structures that have a Size field indicating their size in bytes.

Member Typedef Documentation

value_type

template<typename TEntity >

using catapult::model::BasicContiguousEntityContainer< TEntity >::value_type = TEntity

Constructor & Destructor Documentation

BasicContiguousEntityContainer()

template<typename TEntity >

constexpr catapult::model::BasicContiguousEntityContainer< TEntity >::BasicContiguousEntityContainer ( TEntity *  pEntity, size_t  entitiesSize, EntityContainerErrorPolicy  errorPolicy  )

inlineconstexpr

Creates a container around pEntity structures spanning over entitiesSize bytes with the specified error policy (errorPolicy).

Member Function Documentation

begin()

template<typename TEntity >

auto catapult::model::BasicContiguousEntityContainer< TEntity >::begin ( ) const

inline

Returns an iterator that represents the first entity.

cbegin()

template<typename TEntity >

auto catapult::model::BasicContiguousEntityContainer< TEntity >::cbegin ( ) const

inline

Returns a const iterator that represents the first entity.

cend()

template<typename TEntity >

auto catapult::model::BasicContiguousEntityContainer< TEntity >::cend ( ) const

inline

Returns a const iterator that represents one past the last entity.

end()

template<typename TEntity >

auto catapult::model::BasicContiguousEntityContainer< TEntity >::end ( ) const

inline

Returns an iterator that represents one past the last entity.

hasError()

template<typename TEntity >

bool catapult::model::BasicContiguousEntityContainer< TEntity >::hasError ( ) const

inline

Gets a value indicating whether or not there was an iteration error.

Member Data Documentation

m_pStart

template<typename TEntity >

TEntity* catapult::model::BasicContiguousEntityContainer< TEntity >::m_pStart

private

m_state

template<typename TEntity >

State catapult::model::BasicContiguousEntityContainer< TEntity >::m_state

mutableprivate

---

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

• ContiguousEntityContainer.h