ABLATE Source Documentation  0.12.34
ablate::environment::RunEnvironment Class Reference

Classes

class  Parameters
 

Public Member Functions

 RunEnvironment (const parameters::Parameters &, const std::filesystem::path &inputPath={})
 
 RunEnvironment (RunEnvironment &other)=delete
 
void operator= (const RunEnvironment &)=delete
 
const std::filesystem::path & GetOutputDirectory () const
 
void ExpandVariables (std::string &value) const
 

Static Public Member Functions

static void Setup ()
 
static void Setup (const parameters::Parameters &, const std::filesystem::path &inputPath={})
 
static const RunEnvironmentGet ()
 
static void Initialize (int *argc, char ***args)
 
static void RegisterCleanUpFunction (const std::string &name, std::function< void()>)
 
static void Finalize ()
 
static int * GetArgCount ()
 
static char *** GetArgs ()
 
static std::string_view GetVersion ()
 

Member Function Documentation

◆ ExpandVariables()

void ablate::environment::RunEnvironment::ExpandVariables ( std::string &  value) const

replaces any known runtime variables with known values supported values:

  • $OutputDirectory is replaced with outputDirectory
    Parameters
    value
    Returns

◆ Finalize()

void ablate::environment::RunEnvironment::Finalize ( )
static

Last thing that any program should do is cleanup

Parameters
name

◆ GetOutputDirectory()

const std::filesystem::path& ablate::environment::RunEnvironment::GetOutputDirectory ( ) const
inline

Return the path to the root of the current output directory

Returns

◆ GetVersion()

std::string_view ablate::environment::RunEnvironment::GetVersion ( )
static

Return the current version as a string_view to standardize access to the version

◆ Initialize()

void ablate::environment::RunEnvironment::Initialize ( int *  argc,
char ***  args 
)
static

initialize ablate

◆ RegisterCleanUpFunction()

void ablate::environment::RunEnvironment::RegisterCleanUpFunction ( const std::string &  name,
std::function< void()>  newFunction 
)
static

function to register cleanup function


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