openfluid::core::EventsCollection Class Reference

Class defining a collection of discrete events. More...

#include <core/EventsCollection.hpp>

Public Member Functions
	EventsCollection ()=default
virtual	~EventsCollection ()
bool	addEvent (const Event *Ev)
bool	addEvent (const Event &Ev)
bool	getEventsBetween (const DateTime &BeginDate, const DateTime &EndDate, EventsCollection *Events) const
bool	getEventsBetween (const DateTime &BeginDate, const DateTime &EndDate, EventsCollection &Events) const
EventsList_t *	eventsList ()
EventsList_t *	getEventsList ()
int	getCount () const
void	clear ()
void	println () const

Detailed Description

Class defining a collection of discrete events.

Constructor & Destructor Documentation

EventsCollection()

openfluid::core::EventsCollection::EventsCollection ( )

default

Default constructor

~EventsCollection()

virtual openfluid::core::EventsCollection::~EventsCollection ( )

inlinevirtual

Member Function Documentation

addEvent() [1/2]

bool openfluid::core::EventsCollection::addEvent

(

const Event *

Ev

)

Inserts an event in the event collection, ordered by date

Deprecated:

Since version 1.7.1. Use openfluid::core::EventsCollection::addEvent(const Event&) instead

addEvent() [2/2]

bool openfluid::core::EventsCollection::addEvent

(

const Event &

Ev

)

Inserts an event in the event collection, ordered by date

clear()

void openfluid::core::EventsCollection::clear ( )

inline

Clears the event collection

eventsList()

EventsList_t* openfluid::core::EventsCollection::eventsList ( )

inline

Returns the event collection as a list

getCount()

int openfluid::core::EventsCollection::getCount ( ) const

inline

Returns number of events in the event collection

getEventsBetween() [1/2]

bool openfluid::core::EventsCollection::getEventsBetween	(	const DateTime &	BeginDate,
		const DateTime &	EndDate,
		EventsCollection *	Events
	)		const

Returns an event collection extracted from the current event collection, taking into account a time period If some events are already in the given collection, they are not deleted. Events matching the period are appended at the end of the given collection

Deprecated:

Since version 1.7.1. Use openfluid::core::EventsCollection::getEventsBetween(const DateTime&,const DateTime&,EventsCollection&) const instead

getEventsBetween() [2/2]

bool openfluid::core::EventsCollection::getEventsBetween	(	const DateTime &	BeginDate,
		const DateTime &	EndDate,
		EventsCollection &	Events
	)		const

Returns an event collection extracted from the current event collection, taking into account a time period If some events are already in the given collection, they are not deleted. Events matching the period are appended at the end of the given collection

getEventsList()

EventsList_t* openfluid::core::EventsCollection::getEventsList ( )

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::EventsCollection::eventsList() instead

println()

void openfluid::core::EventsCollection::println

(

)

const

---

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

• core/EventsCollection.hpp