Class CSubEnvironmentDescription

• Defined in File SubEnvironmentDescription.h

Inheritance Relationships

Derived Type

• public flamegpu::SubEnvironmentDescription (Class SubEnvironmentDescription)

Class Documentation

class CSubEnvironmentDescription

Subclassed by flamegpu::SubEnvironmentDescription

Public Functions

explicit CSubEnvironmentDescription(std::shared_ptr<SubEnvironmentData> data)

Constructor, creates an interface to the SubEnvironmentData

Parameters:

data – Data store of this subenvironment’s data

explicit CSubEnvironmentDescription(std::shared_ptr<const SubEnvironmentData> data)

CSubEnvironmentDescription(const CSubEnvironmentDescription &other_agent) = default

Copy constructor Creates a new interface to the same SubEnvironmentData/ModelData

CSubEnvironmentDescription(CSubEnvironmentDescription &&other_agent) = default

CSubEnvironmentDescription &operator=(const CSubEnvironmentDescription &other_agent) = default

Assignment operator Assigns this interface to the same SubEnvironmentData/ModelData

CSubEnvironmentDescription &operator=(CSubEnvironmentDescription &&other_agent) = default

bool operator==(const CSubEnvironmentDescription &rhs) const

Equality operator, checks whether SubEnvironmentDescription hierarchies are functionally the same

Note

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

Parameters:

rhs – right hand side

Returns:

True when subenvironments are the same

bool operator!=(const CSubEnvironmentDescription &rhs) const

Equality operator, checks whether SubEnvironmentDescription hierarchies are functionally different

Note

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

Parameters:

rhs – right hand side

Returns:

True when subenvironments are not the same

std::string getPropertyMapping(const std::string &sub_property_name) const

Returns the name of the master property which has been mapped to the named subenvironment property

Const Accessors

Parameters:

sub_property_name – Name of the state in the sub agent to check

Throws:

exception::InvalidEnvProperty – If the sub environment property does not exist or has not been mapped yet

Returns:

The name of the state within the master agent which is mapped

std::string getMacroPropertyMapping(const std::string &sub_property_name) const

Returns the name of the master macro property which has been mapped to the named subenvironment macro property

Parameters:

sub_property_name – Name of the state in the sub agent to check

Throws:

exception::InvalidEnvProperty – If the sub environment property does not exist or has not been mapped yet

Returns:

The name of the state within the master agent which is mapped

std::string getDirectedGraphMapping(const std::string &sub_graph_name) const

Returns the name of the master directed graph which has been mapped to the named subenvironment directed graph

Parameters:

sub_graph_name – Name of the directed graph in the sub environment to check

Throws:

exception::InvalidEnvGraph – If the sub environment directed graph does not exist or has not been mapped yet

Returns:

The name of the directed graph within the master environment which is mapped

Protected Attributes

std::shared_ptr<SubEnvironmentData> subenvironment

The class which stores all of the subenvironment’s data.