Class SubModelDescription

Defined in File SubModelDescription.h

Inheritance Relationships

Base Type

public flamegpu::CSubModelDescription (Class CSubModelDescription)

Class Documentation

class SubModelDescription : public flamegpu::CSubModelDescription 

This class provides an interface to a mapping between the parent and sub-model

Public Functions

explicit SubModelDescription(std::shared_ptr<SubModelData> data)

Constructor, creates an interface to the SubModelData Constructors

Parameters:: data – Data store of this agent’s data

SubModelDescription(const SubModelDescription &other_agent) = default: Copy constructor Creates a new interface to the same SubModelData/ModelData

SubModelDescription(SubModelDescription &&other_agent) = default

SubModelDescription &operator=(const SubModelDescription &other_agent) = default: Assignment operator Assigns this interface to the same SubModelData/ModelData

SubModelDescription &operator=(SubModelDescription &&other_agent) = default

SubAgentDescription bindAgent(const std::string &sub_agent_name, const std::string &master_agent_name, bool auto_map_vars = false, bool auto_map_states = true)

Defines which agent from the parent/master model will be mapped to which agent in the submodel Only 1 master agent can be bound to each sub agent, however the same master agent can be bound to many sub agents Binding an agent to a subagent, ensures the population of subagents is always the same size. Furthermore, agent variables can be mapped so that they are shared between the two agents. Returns SubAgentDescription

which can be used to manually map variables If auto_map_vars is enabled, variables with matching name, type and length will be automatically mapped

Accessors

Parameters:

sub_agent_name – Name of the agent in the submodel (must be unique, 1 bind per subagent)
master_agent_name – Name of the agent in the parent/host/master model
auto_map_vars – Whether to automatically map matching variables of the two agents
auto_map_states – Whether to automatically map matching states of the two agents

Throws:

exception::InvalidSubAgentName – If the sub agent name does not map to a valid agent
exception::InvalidAgentName – If the master agent has already been bound
exception::InvalidSubAgentName – If the sub agent name does not map to a valid agent
exception::InvalidAgentName – If the master agent has already been bound

SubAgentDescription SubAgent(const std::string &sub_agent_name)

Returns a mutable reference to the named SubAgent description if it has already been bound to a master agent