knowrob::TimeInterval Class Reference

#include <TimeInterval.h>

Inheritance diagram for knowrob::TimeInterval:

Collaboration diagram for knowrob::TimeInterval:

Public Member Functions
	TimeInterval (const std::optional< TimePoint > &since, const std::optional< TimePoint > &until)
bool	operator== (const TimeInterval &other) const
std::shared_ptr< TimeInterval >	intersectWith (const TimeInterval &other) const
const auto &	since () const
const auto &	until () const
void	write (std::ostream &os) const override
	TimeInterval (const std::optional< TimePoint > &since, const std::optional< TimePoint > &until)
bool	operator== (const TimeInterval &other) const
std::shared_ptr< TimeInterval >	intersectWith (const TimeInterval &other) const
const auto &	since () const
const auto &	until () const
void	write (std::ostream &os) const override
Public Member Functions inherited from knowrob::Printable
virtual	~Printable ()=default
virtual std::string	format () const
virtual	~Printable ()=default
virtual std::string	format () const

Static Public Member Functions
static const TimeInterval &	anytime ()
static TimeInterval	currently ()
static TimeInterval	during (const TimePoint &begin, const TimePoint &end)
static const TimeInterval &	anytime ()
static TimeInterval	currently ()
static TimeInterval	during (const TimePoint &begin, const TimePoint &end)

Protected Attributes
std::optional< TimePoint >	since_
std::optional< TimePoint >	until_

Detailed Description

A fuzzy time interval where start and end time point lie within a range.

Definition at line 19 of file TimeInterval.h.

Constructor & Destructor Documentation

TimeInterval() [1/2]

TimeInterval::TimeInterval	(	const std::optional< TimePoint > &	since,
		const std::optional< TimePoint > &	until
	)

Parameters

since	the time point where the interval starts
until	the time point where the interval ends

Definition at line 10 of file TimeInterval.cpp.

        : since_(since),
          until_(until) {}

TimeInterval() [2/2]

knowrob::TimeInterval::TimeInterval	(	const std::optional< TimePoint > &	since,
		const std::optional< TimePoint > &	until
	)

Parameters

since	the time point where the interval starts
until	the time point where the interval ends

Member Function Documentation

anytime() [1/2]

const TimeInterval & TimeInterval::anytime ( )

static

Returns

a time interval without further constraints on begin and end time point of the interval.

Definition at line 18 of file TimeInterval.cpp.

                                          {
    static const TimeInterval timeInterval(std::nullopt, std::nullopt);
    return timeInterval;
}

anytime() [2/2]

static const TimeInterval& knowrob::TimeInterval::anytime ( )

static

Returns

a time interval without further constraints on begin and end time point of the interval.

currently() [1/2]

TimeInterval TimeInterval::currently ( )

static

Returns

a time interval that at least intersects with the current time.

Definition at line 23 of file TimeInterval.cpp.

                                     {
    TimePoint now = time::now();
    return {now, now};
}

currently() [2/2]

static TimeInterval knowrob::TimeInterval::currently ( )

static

Returns

a time interval that at least intersects with the current time.

during() [1/2]

TimeInterval TimeInterval::during ( const TimePoint &  begin, const TimePoint &  end  )

static

Parameters

begin	the begin time point of the interval
end	the end time point of the interval

Returns

a time interval that is valid between the given time points

Definition at line 28 of file TimeInterval.cpp.

                                                                              {
    return {begin, end};
}

during() [2/2]

static TimeInterval knowrob::TimeInterval::during ( const TimePoint &  begin, const TimePoint &  end  )

static

Parameters

begin	the begin time point of the interval
end	the end time point of the interval

Returns

a time interval that is valid between the given time points

intersectWith() [1/2]

std::shared_ptr< TimeInterval > TimeInterval::intersectWith

(

const TimeInterval &

other

)

const

Intersect this time interval with another one.

Parameters

other

another time interval.

Definition at line 32 of file TimeInterval.cpp.

                                                                                       {
    return std::make_shared<TimeInterval>(std::max(since_, other.since_), std::min(until_, other.until_));
}

intersectWith() [2/2]

std::shared_ptr<TimeInterval> knowrob::TimeInterval::intersectWith

(

const TimeInterval &

other

)

const

Intersect this time interval with another one.

Parameters

other

another time interval.

operator==() [1/2]

bool TimeInterval::operator==

(

const TimeInterval &

other

)

const

Parameters

other

another time interval

Returns

true if both time intervals are equal

Definition at line 14 of file TimeInterval.cpp.

                                                             {
    return since_ == other.since_ && until_ == other.until_;
}

operator==() [2/2]

bool knowrob::TimeInterval::operator==

(

const TimeInterval &

other

)

const

Parameters

other

another time interval

Returns

true if both time intervals are equal

since() [1/2]

const auto& knowrob::TimeInterval::since ( ) const

inline

Returns

the begin time point of the interval

Definition at line 59 of file TimeInterval.h.

{ return since_; }

since() [2/2]

const auto& knowrob::TimeInterval::since ( ) const

inline

Returns

the begin time point of the interval

Definition at line 59 of file TimeInterval.h.

{ return since_; }

until() [1/2]

const auto& knowrob::TimeInterval::until ( ) const

inline

Returns

the end time point of the interval

Definition at line 64 of file TimeInterval.h.

{ return until_; }

until() [2/2]

const auto& knowrob::TimeInterval::until ( ) const

inline

Returns

the end time point of the interval

Definition at line 64 of file TimeInterval.h.

{ return until_; }

write() [1/2]

void TimeInterval::write ( std::ostream &  os ) const

overridevirtual

Print this object to a stream.

Parameters

os	the stream to print to.

Implements knowrob::Printable.

Definition at line 36 of file TimeInterval.cpp.

                                             {
    os << '[';
    if (since().has_value()) time::write(since().value(), os);
    else os << '_';
    os << ",";
    if (until().has_value()) time::write(until().value(), os);
    else os << '_';
    os << ']';
}

write() [2/2]

void knowrob::TimeInterval::write ( std::ostream &  os ) const

overridevirtual

Print this object to a stream.

Parameters

os	the stream to print to.

Implements knowrob::Printable.

Member Data Documentation

since_

std::optional< TimePoint > knowrob::TimeInterval::since_

protected

Definition at line 70 of file TimeInterval.h.

until_

std::optional< TimePoint > knowrob::TimeInterval::until_

protected

Definition at line 71 of file TimeInterval.h.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/TimeInterval.h
• src/TimeInterval.cpp