TissueForge::event::Event Struct Reference

Inheritance diagram for TissueForge::event::Event:

Collaboration diagram for TissueForge::event::Event:

Public Member Functions
	Event (EventMethod *invokeMethod, EventMethod *predicateMethod)
	Construct an instance using functions.
HRESULT	predicate ()
HRESULT	invoke ()
HRESULT	eval (const FloatP_t &time)
Public Member Functions inherited from TissueForge::event::EventBase
void	remove ()
	Designates event for removal.

Additional Inherited Members
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.

Constructor & Destructor Documentation

Event()

TissueForge::event::Event::Event	(	EventMethod *	invokeMethod,
		EventMethod *	predicateMethod )

Construct an instance using functions.

Parameters

invokeMethod	an invoke function
predicateMethod	a predicate function

Member Function Documentation

eval()

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

virtual

Reimplemented from TissueForge::event::EventBase.

invoke()

HRESULT TissueForge::event::Event::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::Event::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/tfEvent.h