Perimeter for an existing fire to initialize a simulation with. More...

#include <Perimeter.h>

Collaboration diagram for fs::topo::Perimeter:

Public Member Functions
	Perimeter (const string &perim, const Point &point, const Environment &env)
	Initialize perimeter from a file.

	Perimeter (const Location &location, size_t size, const Environment &env)
	Create a Perimeter of the given size at the given Location.

template<class P >
	Perimeter (const Position< P > &position, size_t size, const Environment &env)

const list< Location > &	burned () const noexcept
	Map of all burned Locations.

const list< Location > &	edge () const noexcept
	List of all Locations along the edge of this Perimeter.

Private Attributes
list< Location >	burned_
	Map of burned cells.

list< Location >	edge_
	List of all Locations along the edge of this Perimeter.

Detailed Description

Perimeter for an existing fire to initialize a simulation with.

Constructor & Destructor Documentation

◆ Perimeter() [1/2]

fs::topo::Perimeter::Perimeter	(	const string &	perim,
		const Point &	point,
		const Environment &	env )

Initialize perimeter from a file.

Parameters

perim	File to read from
point	Origin of fire
env	Environment to apply Perimeter to

Here is the call graph for this function:

◆ Perimeter() [2/2]

fs::topo::Perimeter::Perimeter	(	const Location &	location,
		size_t	size,
		const Environment &	env )

Create a Perimeter of the given size at the given Location.

Parameters

location	Location to center Perimeter on
size	Size of Perimeter to create
env	Environment to apply Perimeter to

Here is the call graph for this function:

Member Function Documentation

◆ burned()

const list< Location > & fs::topo::Perimeter::burned ( ) const

nodiscardnoexcept

Map of all burned Locations.

Returns: All Locations burned by this Perimeter

List of all burned Locations

Returns: All Locations burned by this Perimeter

Here is the caller graph for this function:

◆ edge()

const list< Location > & fs::topo::Perimeter::edge ( ) const

nodiscardnoexcept

List of all Locations along the edge of this Perimeter.

Returns: All Locations along the edge of this Perimeter

Member Data Documentation

◆ burned_

list<Location> fs::topo::Perimeter::burned_

private

Map of burned cells.