Class HostFunctionDescription

• Defined in File HostFunctionDescription.h

Inheritance Relationships

Base Type

• public flamegpu::DependencyNode (Class DependencyNode)

Class Documentation

class HostFunctionDescription : public flamegpu::DependencyNode

Within the model hierarchy, this class represents a host function for a FLAMEGPU model

Public Functions

HostFunctionDescription(std::string host_function_name, FLAMEGPU_HOST_FUNCTION_POINTER host_function)

Constructors

HostFunctionDescription(std::string host_function_name, HostFunctionCallback *func_callback)

bool operator==(const HostFunctionDescription &rhs) const

Equality operator, checks whether HostFunctionDescription hierarchies are functionally the same

Note

Instead compare pointers if you wish to check that they are the same instance

Returns:

True when agent functions are the same

bool operator!=(const HostFunctionDescription &rhs) const

Equality operator, checks whether HostFunctionDescription hierarchies are functionally different

Note

Instead compare pointers if you wish to check that they are not the same instance

Returns:

True when agent functions are not the same

FLAMEGPU_HOST_FUNCTION_POINTER getFunctionPtr() const

Returns:

The function pointer for executing the host function if defined via the C/C++ API

HostFunctionCallback *getCallbackObject()

Returns:

The callback function for executing the host function if defined via the Python API

std::string getName()

Accessors

Returns:

The name of the host function