This HasMany<OtherRecord> represents a simple one-to-many relationship between two records. More...

#include <HasMany.hpp>

Public Types
using	ReferencedRecord = OtherRecord
	The record type of the "many" side of the relationship.

using	ReferencedRecordList = std::vector< std::shared_ptr< OtherRecord > >
	The list of records on the "many" side of the relationship.

using	value_type = OtherRecord
	Record type of the "many" side of the relationship.

using	iterator = typename ReferencedRecordList::iterator
	Iterator type for the list of records.

using	const_iterator = typename ReferencedRecordList::const_iterator
	Const iterator type for the list of records.

Public Member Functions
ReferencedRecordList const &	All () const noexcept
	Retrieves the list of loaded records.

ReferencedRecordList &	All () noexcept
	Retrieves the list of records as mutable reference.

template<typename Callable >
void	Each (Callable const &callable)
	Iterates over the list of records and calls the given callable for each record.

ReferencedRecordList &	Emplace (ReferencedRecordList &&records) noexcept
	Emplaces the given list of records.

std::size_t	Count () const noexcept
	Retrieves the number of records in this 1-to-many relationship.

bool	IsEmpty () const noexcept
	Checks if this 1-to-many relationship is empty.

OtherRecord const &	At (std::size_t index) const
	Retrieves the record at the given index.

OtherRecord &	At (std::size_t index)
	Retrieves the record at the given index.

OtherRecord const &	operator[] (std::size_t index) const
	Retrieves the record at the given index.

OtherRecord &	operator[] (std::size_t index)
	Retrieves the record at the given index.

iterator	begin () noexcept

iterator	end () noexcept

const_iterator	begin () const noexcept

const_iterator	end () const noexcept

constexpr std::weak_ordering	operator<=> (HasMany< OtherRecord > const &other) const noexcept=default

constexpr bool	operator== (HasMany< OtherRecord > const &other) const noexcept=default

constexpr bool	operator!= (HasMany< OtherRecord > const &other) const noexcept=default

void	SetAutoLoader (Loader loader) noexcept
	Used internally to configure on-demand loading of the records.

Detailed Description

template<typename OtherRecord>
class HasMany< OtherRecord >

This HasMany<OtherRecord> represents a simple one-to-many relationship between two records.

The HasMany<OtherRecord> is a member of the "one" side of the relationship.

This implemenation of HasMany<OtherRecord> must have only one BelongsTo member that points back to this "one" side.

See also: DataMapper, Field, HasManyThrough

Definition at line 30 of file HasMany.hpp.

Member Typedef Documentation

◆ ReferencedRecord

template<typename OtherRecord >

using HasMany< OtherRecord >::ReferencedRecord = OtherRecord

The record type of the "many" side of the relationship.

Definition at line 34 of file HasMany.hpp.

◆ ReferencedRecordList

template<typename OtherRecord >

using HasMany< OtherRecord >::ReferencedRecordList = std::vector<std::shared_ptr<OtherRecord> >

The list of records on the "many" side of the relationship.

Definition at line 37 of file HasMany.hpp.

◆ value_type

template<typename OtherRecord >

using HasMany< OtherRecord >::value_type = OtherRecord

Record type of the "many" side of the relationship.

Definition at line 40 of file HasMany.hpp.

◆ iterator

template<typename OtherRecord >

using HasMany< OtherRecord >::iterator = typename ReferencedRecordList::iterator

Iterator type for the list of records.

Definition at line 43 of file HasMany.hpp.

◆ const_iterator

template<typename OtherRecord >

using HasMany< OtherRecord >::const_iterator = typename ReferencedRecordList::const_iterator

Const iterator type for the list of records.

Definition at line 46 of file HasMany.hpp.

Member Function Documentation

◆ All() [1/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::ReferencedRecordList const & HasMany< OtherRecord >::All ( ) const

inlinenoexcept

Retrieves the list of loaded records.

Definition at line 171 of file HasMany.hpp.

◆ All() [2/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::ReferencedRecordList & HasMany< OtherRecord >::All ( )

inlinenoexcept

Retrieves the list of records as mutable reference.

Definition at line 150 of file HasMany.hpp.

◆ Each()

template<typename OtherRecord >

template<typename Callable >

void HasMany< OtherRecord >::Each ( Callable const & callable )

Iterates over the list of records and calls the given callable for each record.

Note: Use this method if you want to iterate over all records but do not need to store them all in memory, e.g. because the full data set wuold be too large.

Definition at line 158 of file HasMany.hpp.

◆ Emplace()

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::ReferencedRecordList & HasMany< OtherRecord >::Emplace ( ReferencedRecordList && records )

inlinenoexcept

Emplaces the given list of records.

Definition at line 142 of file HasMany.hpp.

◆ Count()

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE std::size_t HasMany< OtherRecord >::Count ( ) const

inlinenoexcept

Retrieves the number of records in this 1-to-many relationship.

Definition at line 179 of file HasMany.hpp.

◆ IsEmpty()

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE bool HasMany< OtherRecord >::IsEmpty ( ) const

inlinenoexcept

Checks if this 1-to-many relationship is empty.

Definition at line 191 of file HasMany.hpp.

◆ At() [1/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE OtherRecord const & HasMany< OtherRecord >::At ( std::size_t index ) const

inline

Retrieves the record at the given index.

Parameters

index The index of the record to retrieve.

Note: This method will on-demand load the records if they are not already loaded.; This method will throw if the index is out of bounds.

Definition at line 197 of file HasMany.hpp.

◆ At() [2/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE OtherRecord & HasMany< OtherRecord >::At ( std::size_t index )

inline

Retrieves the record at the given index.

Parameters

index The index of the record to retrieve.

Note: This method will on-demand load the records if they are not already loaded.; This method will throw if the index is out of bounds.

Definition at line 204 of file HasMany.hpp.

◆ operator[]() [1/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE OtherRecord const & HasMany< OtherRecord >::operator[] ( std::size_t index ) const

inline

Retrieves the record at the given index.

Parameters

index The index of the record to retrieve.

Note: This method will on-demand load the records if they are not already loaded.; This method will NOT throw if the index is out of bounds. The behaviour is undefined.

Definition at line 211 of file HasMany.hpp.

◆ operator[]() [2/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE OtherRecord & HasMany< OtherRecord >::operator[] ( std::size_t index )

inline

Retrieves the record at the given index.

Parameters

index The index of the record to retrieve.

Note: This method will on-demand load the records if they are not already loaded.; This method will NOT throw if the index is out of bounds. The behaviour is undefined.

Definition at line 218 of file HasMany.hpp.

◆ begin() [1/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::iterator HasMany< OtherRecord >::begin ( )

inlinenoexcept

Definition at line 225 of file HasMany.hpp.

◆ end() [1/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::iterator HasMany< OtherRecord >::end ( )

inlinenoexcept

Definition at line 232 of file HasMany.hpp.

◆ begin() [2/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::const_iterator HasMany< OtherRecord >::begin ( ) const

inlinenoexcept

Definition at line 239 of file HasMany.hpp.

◆ end() [2/2]

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE HasMany< OtherRecord >::const_iterator HasMany< OtherRecord >::end ( ) const

inlinenoexcept

Definition at line 246 of file HasMany.hpp.

◆ SetAutoLoader()

template<typename OtherRecord >

LIGHTWEIGHT_FORCE_INLINE void HasMany< OtherRecord >::SetAutoLoader ( Loader loader )

inlinenoexcept

Used internally to configure on-demand loading of the records.

Definition at line 129 of file HasMany.hpp.

Referenced by DataMapper::ConfigureRelationAutoLoading().

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

Lightweight/DataMapper/HasMany.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ReferencedRecord

◆ ReferencedRecordList

◆ value_type

◆ iterator

◆ const_iterator

Member Function Documentation

◆ All() [1/2]

◆ All() [2/2]

◆ Each()

◆ Emplace()

◆ Count()

◆ IsEmpty()

◆ At() [1/2]

◆ At() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]

◆ SetAutoLoader()