DiFfRG::OutputPath Class Reference

#include <output_path.hh>

Public Member Functions
	OutputPath ()=delete
	OutputPath (std::filesystem::path root, std::string run_name, std::filesystem::path field_directory="output")
	OutputPath (const ConfigTree &config)
	OutputPath (const OutputPath &)=default
OutputPath &	operator= (const OutputPath &)=default
	OutputPath (OutputPath &&) noexcept=default
OutputPath &	operator= (OutputPath &&) noexcept=default
const std::filesystem::path &	root () const noexcept
const std::string &	run_name () const noexcept
const std::filesystem::path &	field_directory () const noexcept
std::filesystem::path	resolve (std::filesystem::path relative) const
std::filesystem::path	run_file (std::string_view extension) const
std::filesystem::path	run_file (std::string_view name_suffix, std::string_view extension) const
OutputPath	child (std::filesystem::path directory, std::string run_name, std::filesystem::path field_directory="output") const
void	copy_tree_from (const std::filesystem::path &source) const

Static Public Member Functions
static OutputPath	temporary (TemporaryRetention retention=TemporaryRetention::remove_on_destruction, std::string run_name="output", std::filesystem::path field_directory="output")
static std::filesystem::path	checked_relative (std::filesystem::path path, std::string_view kind="output path")

Private Member Functions
	OutputPath (std::filesystem::path root, std::string run_name, std::filesystem::path field_directory, std::shared_ptr< const OutputRoot > output_root)

Private Attributes
std::filesystem::path	root_path
std::string	output_name
std::filesystem::path	fields_path
std::shared_ptr< const OutputRoot >	output_root

Detailed Description

Shared immutable owner and validated filesystem layout for one output run.

Constructor & Destructor Documentation

OutputPath() [1/6]

DiFfRG::OutputPath::OutputPath ( )

delete

OutputPath() [2/6]

DiFfRG::OutputPath::OutputPath	(	std::filesystem::path	root,
		std::string	run_name,
		std::filesystem::path	field_directory = "output" )

OutputPath() [3/6]

DiFfRG::OutputPath::OutputPath ( const ConfigTree & config )

explicit

OutputPath() [4/6]

DiFfRG::OutputPath::OutputPath ( const OutputPath & )

default

OutputPath() [5/6]

DiFfRG::OutputPath::OutputPath ( OutputPath && )

defaultnoexcept

OutputPath() [6/6]

DiFfRG::OutputPath::OutputPath ( std::filesystem::path root, std::string run_name, std::filesystem::path field_directory, std::shared_ptr< const OutputRoot > output_root )

private

Member Function Documentation

checked_relative()

static std::filesystem::path DiFfRG::OutputPath::checked_relative ( std::filesystem::path path, std::string_view kind = "output path" )

static

child()

OutputPath DiFfRG::OutputPath::child	(	std::filesystem::path	directory,
		std::string	run_name,
		std::filesystem::path	field_directory = "output" ) const

copy_tree_from()

void DiFfRG::OutputPath::copy_tree_from

(

const std::filesystem::path &

source

)

const

field_directory()

const std::filesystem::path & DiFfRG::OutputPath::field_directory ( ) const

inlinenoexcept

operator=() [1/2]

OutputPath & DiFfRG::OutputPath::operator= ( const OutputPath & )

default

operator=() [2/2]

OutputPath & DiFfRG::OutputPath::operator= ( OutputPath && )

defaultnoexcept

resolve()

std::filesystem::path DiFfRG::OutputPath::resolve

(

std::filesystem::path

relative

)

const

root()

const std::filesystem::path & DiFfRG::OutputPath::root ( ) const

inlinenoexcept

run_file() [1/2]

std::filesystem::path DiFfRG::OutputPath::run_file

(

std::string_view

extension

)

const

run_file() [2/2]

std::filesystem::path DiFfRG::OutputPath::run_file	(	std::string_view	name_suffix,
		std::string_view	extension ) const

Companion of run_file carrying an extra suffix: <run name><name_suffix><extension>.

run_name()

const std::string & DiFfRG::OutputPath::run_name ( ) const

inlinenoexcept

temporary()

static OutputPath DiFfRG::OutputPath::temporary ( TemporaryRetention retention = TemporaryRetention::remove_on_destruction, std::string run_name = "output", std::filesystem::path field_directory = "output" )

static

Member Data Documentation

fields_path

std::filesystem::path DiFfRG::OutputPath::fields_path

private

output_name

std::string DiFfRG::OutputPath::output_name

private

output_root

std::shared_ptr<const OutputRoot> DiFfRG::OutputPath::output_root

private

root_path

std::filesystem::path DiFfRG::OutputPath::root_path

private

---

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

• /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/DiFfRG/discretization/data/output_path.hh