FireSTARR
Loading...
Searching...
No Matches
fs::EnvironmentInfo Class Reference

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

#include <EnvironmentInfo.h>

Collaboration diagram for fs::EnvironmentInfo:

Public Member Functions

 EnvironmentInfo (const string_view in_fuel, const string_view in_elevation)
 Construct from given rasters.
 
 EnvironmentInfo (EnvironmentInfo &&rhs) noexcept=default
 
 EnvironmentInfo (const EnvironmentInfo &rhs)=delete
 
EnvironmentInfo & operator= (EnvironmentInfo &&rhs) noexcept=default
 
EnvironmentInfo & operator= (const EnvironmentInfo &rhs)=delete
 
std::optional< Coordinates > findCoordinates (const Point &point, bool flipped) const
 Determine Coordinates in the grid for the Point.
 
std::optional< FullCoordinates > findFullCoordinates (const Point &point, bool flipped) const
 Determine FullCoordinates in the grid for the Point.
 
bool validate (const Point &point) const
 
Environment load (const Point &point) const
 Load the full Environment.
 
constexpr FullIdx calculateHeight () const
 
constexpr FullIdx calculateWidth () const
 
constexpr const string & proj4 () const
 UTM projection that this uses.
 

Static Public Member Functions

static unique_ptr< EnvironmentInfo > loadInfo (const string_view in_fuel, const string_view in_elevation)
 Load EnvironmentInfo from given rasters.
 

Private Member Functions

 EnvironmentInfo (const string_view in_fuel, const string_view in_elevation, GridBase &&fuel, GridBase &&elevation) noexcept
 Constructor.
 

Private Attributes

GridBase fuel_
 Information about fuel raster.
 
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/2]

fs::EnvironmentInfo::EnvironmentInfo ( const string_view in_fuel,
const string_view in_elevation )

Construct from given rasters.

Parameters
in_fuelFuel raster
in_elevationElevation raster
Here is the caller graph for this function:

◆ EnvironmentInfo() [2/2]

fs::EnvironmentInfo::EnvironmentInfo ( const string_view in_fuel,
const string_view in_elevation,
GridBase && fuel,
GridBase && elevation )
privatenoexcept

Constructor.

Parameters
in_fuelFuel raster path
in_elevationElevation raster path
fuelInformation about fuel raster
elevationInformation about elevation raster

Member Function Documentation

◆ findCoordinates()

std::optional< Coordinates > fs::EnvironmentInfo::findCoordinates ( const Point & point,
bool flipped ) const
nodiscard

Determine Coordinates in the grid for the Point.

Parameters
pointPoint to find Coordinates for
flippedWhether 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()

std::optional< FullCoordinates > fs::EnvironmentInfo::findFullCoordinates ( const Point & point,
bool flipped ) const
nodiscard

Determine FullCoordinates in the grid for the Point.

Parameters
pointPoint to find FullCoordinates for
flippedWhether 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::EnvironmentInfo::load ( const Point & point) const
nodiscard

Load the full Environment.

Parameters
pointOrigin Point
Returns
Here is the call graph for this function:

◆ loadInfo()

unique_ptr< EnvironmentInfo > fs::EnvironmentInfo::loadInfo ( const string_view in_fuel,
const string_view in_elevation )
staticnodiscard

Load EnvironmentInfo from given rasters.

Parameters
in_fuelFuel raster
in_elevationElevation raster
Returns
EnvironmentInfo
Here is the call graph for this function:
Here is the caller graph for this function:

◆ proj4()

const string & fs::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: