Struct EnvironmentDirectedGraphData

Struct Documentation

struct EnvironmentDirectedGraphData

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

Public Functions

bool operator==(const EnvironmentDirectedGraphData &rhs) const

Equality operator, checks whether EnvironmentDirectedGraphData 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 directed graphs are the same

bool operator!=(const EnvironmentDirectedGraphData &rhs) const

Equality operator, checks whether EnvironmentDirectedGraphData 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 directed graphs are not the same

explicit EnvironmentDirectedGraphData(const EnvironmentDirectedGraphData &other) = delete

Default copy constructor should not be used

Public Members

std::weak_ptr<const ModelData> model

Parent model

VariableMap vertexProperties = {}

Holds all of the graphs’s vertex property definitions

VariableMap edgeProperties = {}

Holds all of the graphs’s edge property definitions

std::string name

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

Protected Functions

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

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

Parameters:
explicit EnvironmentDirectedGraphData(const std::shared_ptr<const EnvironmentData> &parent, const std::string &graph_name)

Normal constructor, only to be called by ModelDescription

Parameters:
  • parent – The environment which owns the graph

  • graph_name – Name of the graph

Friends

friend class EnvironmentDescription
friend struct EnvironmentData