Catch::Generators::TakeGenerator< T > Class Template Reference

#include <catch_generators_generic.hpp>

Inheritance diagram for Catch::Generators::TakeGenerator< T >:

Collaboration diagram for Catch::Generators::TakeGenerator< T >:

Public Member Functions
	TakeGenerator (size_t target, GeneratorWrapper< T > &&generator)
T const &	get () const override
bool	next () override
	TakeGenerator (size_t target, GeneratorWrapper< T > &&generator)
T const &	get () const override
bool	next () override
Public Member Functions inherited from Catch::Generators::IGenerator< T >
virtual	~IGenerator ()=default
virtual	~IGenerator ()=default
Public Member Functions inherited from Catch::Generators::GeneratorUntypedBase
	GeneratorUntypedBase ()=default
virtual	~GeneratorUntypedBase ()
	GeneratorUntypedBase ()=default
virtual	~GeneratorUntypedBase ()

Additional Inherited Members
Public Types inherited from Catch::Generators::IGenerator< T >
using	type = T

Detailed Description

template<typename T>
class Catch::Generators::TakeGenerator< T >

Definition at line 3700 of file catch.hpp.

Constructor & Destructor Documentation

TakeGenerator() [1/2]

template<typename T >

Catch::Generators::TakeGenerator< T >::TakeGenerator ( size_t target, GeneratorWrapper< T > && generator )

inline

Definition at line 21 of file catch_generators_generic.hpp.

                                                                     :
            m_generator(std::move(generator)),
            m_target(target)
        {
            assert(target != 0 && "Empty generators are not allowed");
        }

TakeGenerator() [2/2]

template<typename T >

Catch::Generators::TakeGenerator< T >::TakeGenerator ( size_t target, GeneratorWrapper< T > && generator )

inline

Definition at line 3705 of file catch.hpp.

                                                                     :
            m_generator(std::move(generator)),
            m_target(target)
        {
            assert(target != 0 && "Empty generators are not allowed");
        }

Member Function Documentation

get() [1/2]

template<typename T >

T const & Catch::Generators::TakeGenerator< T >::get ( ) const

inlineoverridevirtual

Implements Catch::Generators::IGenerator< T >.

Definition at line 27 of file catch_generators_generic.hpp.

                                      {
            return m_generator.get();
        }

get() [2/2]

template<typename T >

T const & Catch::Generators::TakeGenerator< T >::get ( ) const

inlineoverridevirtual

Implements Catch::Generators::IGenerator< T >.

Definition at line 3711 of file catch.hpp.

                                      {
            return m_generator.get();
        }

Here is the call graph for this function:

next() [1/2]

template<typename T >

bool Catch::Generators::TakeGenerator< T >::next ( )

inlineoverridevirtual

Implements Catch::Generators::GeneratorUntypedBase.

Definition at line 30 of file catch_generators_generic.hpp.

                             {
            ++m_returned;
            if (m_returned >= m_target) {
                return false;
            }
 
            const auto success = m_generator.next();
            // If the underlying generator does not contain enough values
            // then we cut short as well
            if (!success) {
                m_returned = m_target;
            }
            return success;
        }

next() [2/2]

template<typename T >

bool Catch::Generators::TakeGenerator< T >::next ( )

inlineoverridevirtual

Implements Catch::Generators::GeneratorUntypedBase.

Definition at line 3714 of file catch.hpp.

                             {
            ++m_returned;
            if (m_returned >= m_target) {
                return false;
            }
 
            const auto success = m_generator.next();
            // If the underlying generator does not contain enough values
            // then we cut short as well
            if (!success) {
                m_returned = m_target;
            }
            return success;
        }

Here is the call graph for this function:

---

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

• libraries/sys-vm/external/Catch2/include/internal/catch_generators_generic.hpp
• libraries/sys-vm/external/Catch2/single_include/catch2/catch.hpp