Utopia::DataIO::Default::IntervalDecider< Model > Struct Template Reference

A decider that returns true when within certain time intervals. More...

#include <defaults.hh>

Inheritance diagram for Utopia::DataIO::Default::IntervalDecider< Model >:

Collaboration diagram for Utopia::DataIO::Default::IntervalDecider< Model >:

Public Types
using	Base = Decider< Model >
	The base class.

Public Member Functions
virtual bool	operator() (Model &m) override
virtual void	set_from_cfg (const Config &cfg) override
	Set the decider up from a given config node.
	IntervalDecider ()=default
	IntervalDecider (const IntervalDecider &)=default
	IntervalDecider (IntervalDecider &&)=default
IntervalDecider &	operator= (const IntervalDecider &)=default
IntervalDecider &	operator= (IntervalDecider &&)=default
virtual	~IntervalDecider ()=default
Public Member Functions inherited from Utopia::DataIO::Default::Decider< Model >
	Decider ()=default
	Decider (const Decider &)=default
	Decider (Decider &&)=default
Decider &	operator= (const Decider &)=default
Decider &	operator= (Decider &&)=default
virtual	~Decider ()=default

Public Attributes
std::list< std::array< std::size_t, 3 > >	intervals
	The sequence of intervals within to return true.

Detailed Description

template<typename Model>
struct Utopia::DataIO::Default::IntervalDecider< Model >

A decider that returns true when within certain time intervals.

Every interval is of shape [start, stop), stride where the third argument is optional and defines a stepping size.

Member Typedef Documentation

Base

template<typename Model >

using Utopia::DataIO::Default::IntervalDecider< Model >::Base = Decider< Model >

The base class.

Constructor & Destructor Documentation

IntervalDecider() [1/3]

template<typename Model >

Utopia::DataIO::Default::IntervalDecider< Model >::IntervalDecider ( )

default

IntervalDecider() [2/3]

template<typename Model >

Utopia::DataIO::Default::IntervalDecider< Model >::IntervalDecider ( const IntervalDecider< Model > &  )

default

IntervalDecider() [3/3]

template<typename Model >

Utopia::DataIO::Default::IntervalDecider< Model >::IntervalDecider ( IntervalDecider< Model > &&  )

default

~IntervalDecider()

template<typename Model >

virtual Utopia::DataIO::Default::IntervalDecider< Model >::~IntervalDecider ( )

virtualdefault

Member Function Documentation

operator()()

template<typename Model >

virtual bool Utopia::DataIO::Default::IntervalDecider< Model >::operator() ( Model &  m )

inlineoverridevirtual

Implements Utopia::DataIO::Default::Decider< Model >.

    {
        // Are at the end of the current interval; pop it, such that
        // at next invocation the front is the new interval
        if (intervals.size() != 0 and m.get_time() == intervals.front()[1])
        {
            intervals.pop_front();
        }
 
        if (intervals.size() != 0)
        {
            const auto [start, stop, step] = intervals.front();
            // Check if within [start, end) interval
            if ((m.get_time() >= start) and (m.get_time() < stop) and
                ((m.get_time() - start) % step == 0))
            {
                return true;
            }
        }
        return false;
    }

operator=() [1/2]

template<typename Model >

IntervalDecider & Utopia::DataIO::Default::IntervalDecider< Model >::operator= ( const IntervalDecider< Model > &  )

default

operator=() [2/2]

template<typename Model >

IntervalDecider & Utopia::DataIO::Default::IntervalDecider< Model >::operator= ( IntervalDecider< Model > &&  )

default

set_from_cfg()

template<typename Model >

virtual void Utopia::DataIO::Default::IntervalDecider< Model >::set_from_cfg ( const Config &  cfg )

inlineoverridevirtual

Set the decider up from a given config node.

Parameters

cfg	config node containing arguments for this decider

Implements Utopia::DataIO::Default::Decider< Model >.

    {
        auto tmp = get_as< std::list< std::vector< std::size_t > > >(
            "intervals", cfg);
        for (std::vector< std::size_t > tmp_interval : tmp)
        {
            if (tmp_interval.size() == 2)
            {
                tmp_interval.push_back(1);
            }
            else if (tmp_interval.size() != 3)
            {
                throw Utopia::KeyError("intervals", cfg,
                    fmt::format("Array of unexpected length {}! "
                        "Expected array of length 2 or 3 [start, stop, step] "
                        "with step optional (default 1).",
                        tmp_interval.size())
                    );
            }
 
            std::array< std::size_t, 3 > interval;
            std::copy(tmp_interval.begin(), tmp_interval.end(),
                      interval.begin());
            intervals.push_back(interval);
        }
    }

Member Data Documentation

intervals

template<typename Model >

std::list< std::array< std::size_t, 3 > > Utopia::DataIO::Default::IntervalDecider< Model >::intervals

The sequence of intervals within to return true.

---

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

• include/utopia/data_io/data_manager/defaults.hh