Struct MessageBruteForce::Data

• Defined in File MessageBruteForceHost.h

Nested Relationships

This struct is a nested type of Class MessageBruteForce.

Inheritance Relationships

Derived Types

• public flamegpu::MessageArray2D::Data (Struct MessageArray2D::Data)

• public flamegpu::MessageArray3D::Data (Struct MessageArray3D::Data)

• public flamegpu::MessageArray::Data (Struct MessageArray::Data)

• public flamegpu::MessageBucket::Data (Struct MessageBucket::Data)

• public flamegpu::MessageSpatial2D::Data (Struct MessageSpatial2D::Data)

Struct Documentation

struct Data

This is the internal data store for MessageDescription Users should only access that data stored within via an instance of MessageDescription

Subclassed by flamegpu::MessageArray2D::Data, flamegpu::MessageArray3D::Data, flamegpu::MessageArray::Data, flamegpu::MessageBucket::Data, flamegpu::MessageSpatial2D::Data

Public Functions

virtual ~Data() = default

bool operator==(const Data &rhs) const

Equality operator, checks whether MessageData hierarchies are functionally the same

Note

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

Returns:

True when messages are the same

bool operator!=(const Data &rhs) const

Equality operator, checks whether MessageData hierarchies are functionally different

Note

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

Returns:

True when messages are not the same

Data(const Data &other) = delete

Default copy constructor, not implemented

virtual std::unique_ptr<MessageSpecialisationHandler> getSpecialisationHander(detail::CUDAMessage &owner) const

virtual std::type_index getType() const

Used internally to validate that the corresponding Message type is attached via the agent function shim.

Returns:

The std::type_index of the Message type which must be used.

virtual flamegpu::MessageSortingType getSortingType() const

Return the sorting type for this message type

Public Members

std::weak_ptr<const ModelData> model

Parent model

VariableMap variables

Holds all of the message’s variable definitions

std::string name

Name of the message, used to refer to the message in many functions

bool persistent

Boolean indicating if the message list is allowed to persist iterations or not

unsigned int optional_outputs

The number of functions that have optional output of this message type This value is modified by AgentFunctionDescription

Protected Functions

virtual Data *clone(const std::shared_ptr<const ModelData> &newParent)

Data(std::shared_ptr<const ModelData> model, const Data &other)

Copy constructor This is unsafe, should only be used internally, use clone() instead

Data(std::shared_ptr<const ModelData> model, const std::string &message_name)

Data

Normal constructor, only to be called by ModelDescription

Friends

friend class ModelDescription

friend struct ModelData