Class CSubModelDescription

Inheritance Relationships

Base Type

Derived Type

Class Documentation

class CSubModelDescription : public flamegpu::DependencyNode

Subclassed by flamegpu::SubModelDescription

Public Functions

explicit CSubModelDescription(std::shared_ptr<SubModelData> data)

Constructor, creates an interface to the SubModelData

Parameters

data – Data store of this submodel’s data

explicit CSubModelDescription(std::shared_ptr<const SubModelData> data)
CSubModelDescription(const CSubModelDescription &other_agent) = default

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

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

Assignment operator Assigns this interface to the same SubModelData/ModelData

CSubModelDescription &operator=(CSubModelDescription &&other_agent) = default
bool operator==(const CSubModelDescription &rhs) const

Equality operator, checks whether SubModelDescription 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 submodels are the same

bool operator!=(const CSubModelDescription &rhs) const

Equality operator, checks whether SubModelDescription 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 submodels are not the same

unsigned int getMaxSteps() const

Return the current value of max steps, defaults to 0 This is the maximum number of steps per call of the submodel 0 is unlimited, however requires the model to have an exit condition

Const Accessors

const std::string getName() const

Return the name assigned to the submodel

Note

This may differ from the name of the ModelDescription for the submodel

Protected Attributes

std::shared_ptr<SubModelData> submodel

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