TissueForge::event::TimeEvent Struct Reference

Inheritance diagram for TissueForge::event::TimeEvent:

Collaboration diagram for TissueForge::event::TimeEvent:

Public Member Functions
	TimeEvent (const FloatP_t &period, TimeEventMethod *invokeMethod, TimeEventMethod *predicateMethod=NULL, TimeEventNextTimeSetter *nextTimeSetter=NULL, const FloatP_t &start_time=0, const FloatP_t &end_time=-1)
HRESULT	predicate ()
HRESULT	invoke ()
HRESULT	eval (const FloatP_t &time)
Public Member Functions inherited from TissueForge::event::EventBase
void	remove ()
	Designates event for removal.

Public Attributes
FloatP_t	next_time
	Next time of evaluation.
FloatP_t	period
	Period of evaluation.
FloatP_t	start_time
	Start time of evaluations.
FloatP_t	end_time
	End time of evaluations.
Public Attributes inherited from TissueForge::event::EventBase
std::forward_list< EventFlag >	flags
FloatP_t	last_fired
	Record of last time fired.
int	times_fired
	Record of how many times fired.

Protected Member Functions
FloatP_t	getNextTime (const FloatP_t &current_time)
HRESULT	setTimeEventNextTimeSetter (TimeEventTimeSetterEnum setterEnum)

Member Function Documentation

eval()

HRESULT TissueForge::event::TimeEvent::eval ( const FloatP_t & time )

virtual

Reimplemented from TissueForge::event::EventBase.

invoke()

HRESULT TissueForge::event::TimeEvent::invoke ( )

virtual

What occurs during an event. Typically, this invokes an underlying specialized method returns 0 if OK and 1 on error.

Implements TissueForge::event::EventBase.

predicate()

HRESULT TissueForge::event::TimeEvent::predicate ( )

virtual

Evaluates an event predicate, returns 0 if the event should not fire, 1 if the event should, and a negative value on error. A predicate without a defined predicate method always returns 0

Implements TissueForge::event::EventBase.

---

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

• source/event/tfTimeEvent.h