VIPRA Documentation
Loading...
Searching...
No Matches
VIPRA::Modules::MapInput Class Referenceabstract

Base MapInput Module. More...

#include <map_input.hpp>

Inheritance diagram for VIPRA::Modules::MapInput:

Public Member Functions

virtual void load (std::string const &)=0
 
virtual auto get_obstacles () const -> std::optional< std::vector< VIPRA::Geometry::Polygon > >=0
 Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.
 
virtual auto get_spawns () const -> std::optional< std::vector< VIPRA::Geometry::Polygon > >=0
 Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.
 
virtual auto get_objectives () const -> std::optional< std::map< std::string, std::vector< VIPRA::Geometry::Polygon > > >=0
 Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.
 
virtual auto get_areas () const -> std::optional< std::map< std::string, VIPRA::Geometry::Polygon > >=0
 Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.
 
 MapInput (const MapInput &)=default
 
 MapInput (MapInput &&)=default
 
auto operator= (const MapInput &) -> MapInput &=default
 
auto operator= (MapInput &&) -> MapInput &=default
 

Detailed Description

Base MapInput Module.

Member Function Documentation

◆ get_areas()

virtual auto VIPRA::Modules::MapInput::get_areas ( ) const -> std::optional< std::map< std::string, VIPRA::Geometry::Polygon > >
nodiscardpure virtual

Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.

Template Parameters
data_t
key_ts
Parameters
key
Returns
std::vector<Geometry::Polygon>

Implemented in DXF, and VIPRA::Input::JSON.

◆ get_objectives()

virtual auto VIPRA::Modules::MapInput::get_objectives ( ) const -> std::optional< std::map< std::string, std::vector< VIPRA::Geometry::Polygon > > >
nodiscardpure virtual

Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.

Template Parameters
data_t
key_ts
Parameters
key
Returns
std::vector<Geometry::Polygon>

Implemented in DXF, and VIPRA::Input::JSON.

◆ get_obstacles()

virtual auto VIPRA::Modules::MapInput::get_obstacles ( ) const -> std::optional< std::vector< VIPRA::Geometry::Polygon > >
nodiscardpure virtual

Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.

Template Parameters
data_t
key_ts
Parameters
key
Returns
std::vector<Geometry::Polygon>

Implemented in DXF, and VIPRA::Input::JSON.

◆ get_spawns()

virtual auto VIPRA::Modules::MapInput::get_spawns ( ) const -> std::optional< std::vector< VIPRA::Geometry::Polygon > >
nodiscardpure virtual

Returns polygons as loaded from the input module, std::nullopt if incorrect type / doesn't exist.

Template Parameters
data_t
key_ts
Parameters
key
Returns
std::vector<Geometry::Polygon>

Implemented in DXF, and VIPRA::Input::JSON.

◆ load()

virtual void VIPRA::Modules::MapInput::load ( std::string const & )
pure virtual

Implemented in DXF, and VIPRA::Input::JSON.


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