Class HostConditionCallback

Class Documentation

class HostConditionCallback

Virtual Callback class which allows a user to create a callback function for an exit condition. Different to HostFunctionCallback as it returns a value. This is mostly required to allow swig wrapping of host functions in a target language

Public Functions

virtual CONDITION_RESULT run(HostAPI*) = 0

This is the method that will be implemented by a user in Python to define their host condition

Returns:

Either pyflamegpu.EXIT or pyflamegpu.CONTINUE, denoting whether the simulation should exit

inline virtual ~HostConditionCallback()

Virtual destructor for correct inheritance behaviour