#include <paths.h>

Static Public Member Functions

static std::string rta_config (const std::string &run_directory, const int version=3)
 
static std::string run_info (const std::string &run_directory)
 
static std::string run_parameters (const std::string &run_directory, const bool alternate=false)
 
static std::string run_info ()
 
static std::string run_parameters (const bool alternate=false)
 
template<class MetricType >
static std::string interop_filename (const std::string &run_directory, bool use_out=true)
 
template<class MetricType >
static std::string interop_basename (bool use_out=true)
 
static std::string rta_config (const int version=3)
 
static std::string interop_filename (const std::string &run_directory, const std::string &prefix, const std::string &suffix, const size_t cycle, const bool use_out=true)
 
template<class MetricType >
static std::string interop_filename (const std::string &run_directory, const size_t cycle, bool use_out=true)
 

Detailed Description

Location of files written to an RTA run folder

Member Function Documentation

static std::string interop_basename ( bool  use_out = true)
inlinestatic

Generate a file name from a run directory and the metric type

Note
The 'Out' suffix is appended when we read the file. We excluded the Out in certain conditions when writing the file.
Parameters
use_outif true, append "Out" to the end of the filename
Returns
file path to the InterOp directory
static std::string interop_filename ( const std::string &  run_directory,
bool  use_out = true 
)
inlinestatic

Generate a file name from a run directory and the metric type

Note
The 'Out' suffix is appended when we read the file. We excluded the Out in certain conditions when writing the file.
Parameters
run_directoryfile path to the run directory
use_outif true, append "Out" to the end of the filename
Returns
file path to the InterOp directory
static std::string interop_filename ( const std::string &  run_directory,
const std::string &  prefix,
const std::string &  suffix,
const size_t  cycle,
const bool  use_out = true 
)
inlinestatic

Generate a file name from a run directory and the InterOp name for by cycle InterOps

Note
The 'Out' suffix is appended when we read the file. We excluded the Out in certain conditions when writing the file.
Parameters
run_directoryfile path to the run directory
prefixprefix name of the interop file
suffixsuffix name of the interop file
cyclecycle id for by cycle InterOp
use_outif true, append "Out" to the end of the filename
Returns
file path to the InterOp directory
static std::string interop_filename ( const std::string &  run_directory,
const size_t  cycle,
bool  use_out = true 
)
inlinestatic

Generate a file name from a run directory and the metric type for by cycle InterOps

Note
The 'Out' suffix is appended when we read the file. We excluded the Out in certain conditions when writing the file.
Parameters
run_directoryfile path to the run directory
cyclecurrent cycle
use_outif true, append "Out" to the end of the filename
Returns
file path to the InterOp directory
static std::string rta_config ( const std::string &  run_directory,
const int  version = 3 
)
inlinestatic

Get the path to the RTA configuration file

Parameters
run_directoryrun directory
versionversion of RTA
Returns
config filename
static std::string rta_config ( const int  version = 3)
inlinestatic

Get the path to the RTA configuration file

Parameters
versionversion of RTA
Returns
config filename
static std::string run_info ( const std::string &  run_directory)
inlinestatic

Get the path of the RunInfo

Returns
path/to/RunInfo.xml
static std::string run_info ( )
inlinestatic

Get the name of the RunInfo

Returns
RunInfo.xml
static std::string run_parameters ( const std::string &  run_directory,
const bool  alternate = false 
)
inlinestatic

Get the path of the RunParameters

Parameters
run_directoryrun directory
alternatereturn alternate filename
Returns
path/to/RunParameters.xml
static std::string run_parameters ( const bool  alternate = false)
inlinestatic

Get the name of the RunParameters

Parameters
alternatereturn alternate filename
Returns
RunParameters.xml (alternate: runParameters.xml)

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