fs::topo::EnvironmentInfo Class Reference

Information regarding an Environment, such as grids to read and location. More...

#include <EnvironmentInfo.h>

Collaboration diagram for fs::topo::EnvironmentInfo:

Public Member Functions
	EnvironmentInfo (const string &in_fuel, const string &in_elevation)
	Construct from given rasters.
	EnvironmentInfo (EnvironmentInfo &&rhs) noexcept=default
	Move constructor.
	EnvironmentInfo (const EnvironmentInfo &rhs)=delete
EnvironmentInfo &	operator= (EnvironmentInfo &&rhs) noexcept=default
	Move assignment.
EnvironmentInfo &	operator= (const EnvironmentInfo &rhs)=delete
unique_ptr< Coordinates >	findCoordinates (const Point &point, bool flipped) const
	Determine Coordinates in the grid for the Point.
unique_ptr< FullCoordinates >	findFullCoordinates (const Point &point, bool flipped) const
	Determine FullCoordinates in the grid for the Point.
Environment	load (const string dir_out, const Point &point) const
	Load the full Environment using the given FuelLookup to determine fuels.
constexpr FullIdx	calculateRows () const
	Number of rows in grid.
constexpr FullIdx	calculateColumns () const
	Number of columns in grid.
constexpr const string &	proj4 () const
	UTM projection that this uses.

Static Public Member Functions
static unique_ptr< EnvironmentInfo >	loadInfo (const string &in_fuel, const string &in_elevation)
	Load EnvironmentInfo from given rasters.

Private Member Functions
	EnvironmentInfo (string in_fuel, string in_elevation, data::GridBase &&fuel, data::GridBase &&elevation) noexcept
	Constructor.

Private Attributes
data::GridBase	fuel_
	Information about fuel raster.
data::GridBase	elevation_
	Information about elevation raster.
string	in_fuel_
	Fuel raster path.
string	in_elevation_
	Elevation raster path.

Detailed Description

Information regarding an Environment, such as grids to read and location.

Constructor & Destructor Documentation

EnvironmentInfo() [1/3]

fs::topo::EnvironmentInfo::EnvironmentInfo	(	const string &	in_fuel,
		const string &	in_elevation )

Construct from given rasters.

Parameters

in_fuel	Fuel raster
in_elevation	Elevation raster

Here is the caller graph for this function:

EnvironmentInfo() [2/3]

fs::topo::EnvironmentInfo::EnvironmentInfo ( EnvironmentInfo && rhs )

defaultnoexcept

Move constructor.

Parameters

rhs	EnvironmentInfo to move from

EnvironmentInfo() [3/3]

fs::topo::EnvironmentInfo::EnvironmentInfo ( string in_fuel, string in_elevation, data::GridBase && fuel, data::GridBase && elevation )

privatenoexcept

Constructor.

Parameters

in_fuel	Fuel raster path
in_elevation	Elevation raster path
fuel	Information about fuel raster
elevation	Information about elevation raster

Member Function Documentation

calculateColumns()

FullIdx fs::topo::EnvironmentInfo::calculateColumns ( ) const

inlinenodiscardconstexpr

Number of columns in grid.

Returns

Number of columns in grid

Here is the call graph for this function:

calculateRows()

FullIdx fs::topo::EnvironmentInfo::calculateRows ( ) const

inlinenodiscardconstexpr

Number of rows in grid.

Returns

Number of rows in grid

Here is the call graph for this function:

findCoordinates()

unique_ptr< Coordinates > fs::topo::EnvironmentInfo::findCoordinates ( const Point & point, bool flipped ) const

nodiscard

Determine Coordinates in the grid for the Point.

Parameters

point	Point to find Coordinates for
flipped	Whether the grid data is flipped across the horizontal axis

Returns

Coordinates that would be at Point within this EnvironmentInfo, or nullptr if it is not

Here is the call graph for this function:

findFullCoordinates()

unique_ptr< FullCoordinates > fs::topo::EnvironmentInfo::findFullCoordinates ( const Point & point, bool flipped ) const

nodiscard

Determine FullCoordinates in the grid for the Point.

Parameters

point	Point to find FullCoordinates for
flipped	Whether the grid data is flipped across the horizontal axis

Returns

Coordinates that would be at Point within this EnvironmentInfo, or nullptr if it is not

Here is the call graph for this function:

load()

Environment fs::topo::EnvironmentInfo::load ( const string dir_out, const Point & point ) const

nodiscard

Load the full Environment using the given FuelLookup to determine fuels.

Parameters

dir_out	Folder to save outputs to
point	Origin Point

Returns

Here is the call graph for this function:

loadInfo()

unique_ptr< EnvironmentInfo > fs::topo::EnvironmentInfo::loadInfo ( const string & in_fuel, const string & in_elevation )

staticnodiscard

Load EnvironmentInfo from given rasters.

Parameters

in_fuel	Fuel raster
in_elevation	Elevation raster

Returns

EnvironmentInfo

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

EnvironmentInfo & fs::topo::EnvironmentInfo::operator= ( EnvironmentInfo && rhs )

defaultnoexcept

Move assignment.

Parameters

rhs	EnvironmentInfo to move from

Returns

This, after assignment

proj4()

const string & fs::topo::EnvironmentInfo::proj4 ( ) const

inlinenodiscardconstexpr

UTM projection that this uses.

Returns

UTM projection that this uses

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• firestarr/src/cpp/EnvironmentInfo.h
• firestarr/src/cpp/EnvironmentInfo.cpp