TimeSequences::Specified< T > Class Template Reference

An explicitly specified sequence of times. More...

#include <TimeSequence.hpp>

Classes
struct	Values

Public Types
using	options = tmpl::list<Values>

Public Member Functions
	Specified (std::vector< T > values)
std::array< std::optional< T >, 3 >	times_near (T time) const override
	Returns the time in the sequence nearest to time, the time before that, and the time after, in numerical order. These values allow a consumer to find the times in the sequence bracketing the given time and give enough additional information so that exact or roundoff matches can be handled however the consumer wishes. Any time that does not exist (because the sequence terminates) is returned as an empty std::optional. The central std::optional will be populated unless the sequence is empty.
void	pup (PUP::er &p) override
Public Member Functions inherited from TimeSequence< T >
	WRAPPED_PUPable_abstract (TimeSequence)

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<typename T>
class TimeSequences::Specified< T >

An explicitly specified sequence of times.

Member Function Documentation

times_near()

template<typename T>

std::array< std::optional< T >, 3 > TimeSequences::Specified< T >::times_near ( T time ) const

overridevirtual

Returns the time in the sequence nearest to time, the time before that, and the time after, in numerical order. These values allow a consumer to find the times in the sequence bracketing the given time and give enough additional information so that exact or roundoff matches can be handled however the consumer wishes. Any time that does not exist (because the sequence terminates) is returned as an empty std::optional. The central std::optional will be populated unless the sequence is empty.

Implements TimeSequence< T >.

Member Data Documentation

help

template<typename T>

Options::String TimeSequences::Specified< T >::help

staticconstexpr

Initial value:

=
      "An explicitly specified sequence of times."

---

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

• src/Time/TimeSequence.hpp