porytiles::CompilePrimaryTileset Class Reference

Use case for compiling a primary Tileset. More...

#include <compile_primary_tileset.hpp>

Public Member Functions
	CompilePrimaryTileset (gsl::not_null< const TilesetRepo * > tileset_repo, gsl::not_null< const TilesetCompiler * > compiler, gsl::not_null< const TilesetMetadataProvider * > metadata_provider, gsl::not_null< const PorytilesTilesetManager * > tileset_manager, gsl::not_null< const DomainConfig * > domain_config, gsl::not_null< const AppConfig * > app_config, gsl::not_null< const UserDiagnostics * > diag)
	Constructs a CompilePrimaryTileset use case with the given repositories and services.
ChainableResult< void >	compile (const std::string &tileset_name) const
	Compiles the primary Tileset with the given tileset name.

Detailed Description

Use case for compiling a primary Tileset.

Definition at line 21 of file compile_primary_tileset.hpp.

Constructor & Destructor Documentation

CompilePrimaryTileset()

porytiles::CompilePrimaryTileset::CompilePrimaryTileset ( gsl::not_null< const TilesetRepo * >  tileset_repo, gsl::not_null< const TilesetCompiler * >  compiler, gsl::not_null< const TilesetMetadataProvider * >  metadata_provider, gsl::not_null< const PorytilesTilesetManager * >  tileset_manager, gsl::not_null< const DomainConfig * >  domain_config, gsl::not_null< const AppConfig * >  app_config, gsl::not_null< const UserDiagnostics * >  diag  )

inline

Constructs a CompilePrimaryTileset use case with the given repositories and services.

Parameters

tileset_repo	A pointer to the TilesetRepo for this use case.
compiler	A pointer to the TilesetCompiler for this use case.
metadata_provider	A pointer to the TilesetMetadataProvider for this use case.
tileset_manager	A pointer to the PorytilesTilesetManager for this use case.
domain_config	A pointer to the DomainConfig for this use case
app_config	A pointer to the AppConfig for this use case
diag	A pointer to the UserDiagnostics for this use case

Definition at line 34 of file compile_primary_tileset.hpp.

Member Function Documentation

compile()

ChainableResult< void > porytiles::CompilePrimaryTileset::compile

(

const std::string &

tileset_name

)

const

Compiles the primary Tileset with the given tileset name.

Given a primary tileset by name, compile the PorytilesTileset assets into PorymapTileset assets. Uses the use case's configured repos to load and save the tileset assets. Uses the given TilesetCompilationService to perform the compilation operation.

Parameters

tileset_name

The name of the primary Tileset to compile.

Precondition

tileset_name must refer to an existing tileset in the project metadata.

Returns

An empty Result on success, otherwise an error description.

Definition at line 14 of file compile_primary_tileset.cpp.

---

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

• porytiles/include/porytiles/app/use_cases/compile_primary_tileset.hpp
• porytiles/lib/app/use_cases/compile_primary_tileset.cpp