Struct MsgBruteForce::Data

Nested Relationships

This struct is a nested type of Class MsgBruteForce.

Inheritance Relationships

Derived Types

Struct Documentation

struct MsgBruteForce::Data

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

Subclassed by MsgArray2D::Data, MsgArray3D::Data, MsgArray::Data, MsgBucket::Data, MsgSpatial2D::Data

Public Functions

virtual ~Data()
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<MsgSpecialisationHandler> getSpecialisationHander(CUDAMessage &owner) const
virtual std::type_index getType() const

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

Returns

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

Public Members

VariableMap variables

Holds all of the message’s variable definitions

std::unique_ptr<Description> description

Description class which provides convenient accessors

std::string name

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

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(const std::shared_ptr<const ModelData>&, const Data &other)

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

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

Normal constructor, only to be called by ModelDescription

Friends

friend class ModelDescription
friend struct ModelData