This API represents a many-to-many relationship between two records through a third record. More...

#include <HasManyThrough.hpp>

Public Types
using	ThroughRecord = ThroughRecordT
	The record type of the "through" side of the relationship.

using	ReferencedRecord = ReferencedRecordT
	The record type of the "many" side of the relationship.

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

using	value_type = ReferencedRecord

using	iterator = typename ReferencedRecordList::iterator

using	const_iterator = typename ReferencedRecordList::const_iterator

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.

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

std::size_t	Count () const
	Retrieves the number of records in this relationship.

std::size_t	IsEmpty () const
	Checks if this relationship is empty.

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

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

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

ReferencedRecord &	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

std::weak_ordering	operator<=> (HasManyThrough const &other) const noexcept=default

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

void	Reload ()
	Reloads the records from the database.

template<typename Callable >
void	Each (Callable const &callable)
	Iterates over all records in this relationship.

Detailed Description

template<typename ReferencedRecordT, typename ThroughRecordT>
class HasManyThrough< ReferencedRecordT, ThroughRecordT >

This API represents a many-to-many relationship between two records through a third record.

See also: DataMapper, Field, HasMany

Definition at line 21 of file HasManyThrough.hpp.

Member Typedef Documentation

◆ ThroughRecord

template<typename ReferencedRecordT , typename ThroughRecordT >

using HasManyThrough< ReferencedRecordT, ThroughRecordT >::ThroughRecord = ThroughRecordT

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

Definition at line 25 of file HasManyThrough.hpp.

◆ ReferencedRecord

template<typename ReferencedRecordT , typename ThroughRecordT >

using HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecord = ReferencedRecordT

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

Definition at line 28 of file HasManyThrough.hpp.

◆ ReferencedRecordList

template<typename ReferencedRecordT , typename ThroughRecordT >

using HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecordList = std::vector<std::shared_ptr<ReferencedRecord> >

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

Definition at line 31 of file HasManyThrough.hpp.

◆ value_type

template<typename ReferencedRecordT , typename ThroughRecordT >

using HasManyThrough< ReferencedRecordT, ThroughRecordT >::value_type = ReferencedRecord

Definition at line 33 of file HasManyThrough.hpp.

◆ iterator

template<typename ReferencedRecordT , typename ThroughRecordT >

using HasManyThrough< ReferencedRecordT, ThroughRecordT >::iterator = typename ReferencedRecordList::iterator

Definition at line 34 of file HasManyThrough.hpp.

◆ const_iterator

template<typename ReferencedRecordT , typename ThroughRecordT >

using HasManyThrough< ReferencedRecordT, ThroughRecordT >::const_iterator = typename ReferencedRecordList::const_iterator

Definition at line 35 of file HasManyThrough.hpp.

Member Function Documentation

◆ All() [1/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecordList const & HasManyThrough< ReferencedRecordT, ThroughRecordT >::All ( ) const

noexcept

Retrieves the list of loaded records.

Definition at line 150 of file HasManyThrough.hpp.

Referenced by HasManyThrough< ReferencedRecordT, ThroughRecordT >::Each().

◆ All() [2/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecordList & HasManyThrough< ReferencedRecordT, ThroughRecordT >::All ( )

noexcept

Retrieves the list of records as mutable reference.

Definition at line 160 of file HasManyThrough.hpp.

◆ Emplace()

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecordList & HasManyThrough< ReferencedRecordT, ThroughRecordT >::Emplace ( ReferencedRecordList && records )

noexcept

Emplaces the given list of records into this relationship.

Definition at line 170 of file HasManyThrough.hpp.

◆ Count()

template<typename ReferencedRecordT , typename ThroughRecordT >

std::size_t HasManyThrough< ReferencedRecordT, ThroughRecordT >::Count ( ) const

Retrieves the number of records in this relationship.

Definition at line 178 of file HasManyThrough.hpp.

◆ IsEmpty()

template<typename ReferencedRecordT , typename ThroughRecordT >

std::size_t HasManyThrough< ReferencedRecordT, ThroughRecordT >::IsEmpty ( ) const

Checks if this relationship is empty.

Definition at line 190 of file HasManyThrough.hpp.

◆ At() [1/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecord const & HasManyThrough< ReferencedRecordT, ThroughRecordT >::At ( std::size_t index ) const

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 198 of file HasManyThrough.hpp.

◆ At() [2/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecord & HasManyThrough< ReferencedRecordT, ThroughRecordT >::At ( std::size_t index )

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 HasManyThrough.hpp.

◆ operator[]() [1/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecord const & HasManyThrough< ReferencedRecordT, ThroughRecordT >::operator[] ( std::size_t index ) const

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 213 of file HasManyThrough.hpp.

◆ operator[]() [2/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::ReferencedRecord & HasManyThrough< ReferencedRecordT, ThroughRecordT >::operator[] ( std::size_t index )

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 219 of file HasManyThrough.hpp.

◆ begin() [1/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::iterator HasManyThrough< ReferencedRecordT, ThroughRecordT >::begin ( )

noexcept

Definition at line 227 of file HasManyThrough.hpp.

◆ end() [1/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::iterator HasManyThrough< ReferencedRecordT, ThroughRecordT >::end ( )

noexcept

Definition at line 234 of file HasManyThrough.hpp.

◆ begin() [2/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::const_iterator HasManyThrough< ReferencedRecordT, ThroughRecordT >::begin ( ) const

noexcept

Definition at line 241 of file HasManyThrough.hpp.

◆ end() [2/2]

template<typename ReferencedRecordT , typename ThroughRecordT >

HasManyThrough< ReferencedRecordT, ThroughRecordT >::const_iterator HasManyThrough< ReferencedRecordT, ThroughRecordT >::end ( ) const

noexcept

Definition at line 248 of file HasManyThrough.hpp.

◆ SetAutoLoader()

template<typename ReferencedRecordT , typename ThroughRecordT >

void HasManyThrough< ReferencedRecordT, ThroughRecordT >::SetAutoLoader ( Loader loader )

inlinenoexcept

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

Definition at line 95 of file HasManyThrough.hpp.

Referenced by DataMapper::ConfigureRelationAutoLoading().

◆ Reload()

template<typename ReferencedRecordT , typename ThroughRecordT >

void HasManyThrough< ReferencedRecordT, ThroughRecordT >::Reload ( )

inline

Reloads the records from the database.

Definition at line 101 of file HasManyThrough.hpp.

◆ Each()

template<typename ReferencedRecordT , typename ThroughRecordT >

template<typename Callable >

void HasManyThrough< ReferencedRecordT, ThroughRecordT >::Each ( Callable const & callable )

inline

Iterates over all records in this relationship.

Parameters

callable The callable to invoke for each record.

Note: This method will on-demand load the records if they are not already loaded, but not hold them all in memory.

Definition at line 114 of file HasManyThrough.hpp.

References HasManyThrough< ReferencedRecordT, ThroughRecordT >::All().

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

Lightweight/DataMapper/HasManyThrough.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ThroughRecord

◆ ReferencedRecord

◆ ReferencedRecordList

◆ value_type

◆ iterator

◆ const_iterator

Member Function Documentation

◆ All() [1/2]

◆ All() [2/2]

◆ 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()

◆ Reload()

◆ Each()