HOPS
HOPS class reference
Public Member Functions | Static Public Member Functions | List of all members
hops::MHO_Mk4InputConverter Class Reference

Class MHO_Mk4InputConverter. More...

#include <MHO_Mk4InputConverter.hh>

Public Member Functions

 MHO_Mk4InputConverter ()
 
virtual ~MHO_Mk4InputConverter ()
 

Static Public Member Functions

static void cleanup_mk4_temp_dir (const std::string &temp_dir)
 Recursively removes the temporary directory created by convert_mk4_input. More...
 
static std::string convert_mk4_input (MHO_ParameterStore *paramStore)
 Converts a mark4 scan or experiment directory to HOPS format in a temporary directory, then updates '/cmdline/directory' in paramStore to point at the converted output. More...
 

Detailed Description

Class MHO_Mk4InputConverter.

collection of helper functions for fringe fitter start-up

Author
J. Barrettj - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Wed Sep 20 16:40:35 2023 -0400 Tue Sep 19 04:11:24 PM EDT 2023

Constructor & Destructor Documentation

◆ MHO_Mk4InputConverter()

hops::MHO_Mk4InputConverter::MHO_Mk4InputConverter ( )
inline

◆ ~MHO_Mk4InputConverter()

virtual hops::MHO_Mk4InputConverter::~MHO_Mk4InputConverter ( )
inlinevirtual

Member Function Documentation

◆ cleanup_mk4_temp_dir()

void hops::MHO_Mk4InputConverter::cleanup_mk4_temp_dir ( const std::string &  temp_dir)
static

Recursively removes the temporary directory created by convert_mk4_input.

Parameters
temp_dirPath returned by convert_mk4_input. No-op if empty.
Note
This is a static function. Uses POSIX nftw; requires a Linux/POSIX system.

◆ convert_mk4_input()

std::string hops::MHO_Mk4InputConverter::convert_mk4_input ( MHO_ParameterStore paramStore)
static

Converts a mark4 scan or experiment directory to HOPS format in a temporary directory, then updates '/cmdline/directory' in paramStore to point at the converted output.

Parameters
paramStorePointer to MHO_ParameterStore containing '/cmdline/directory'
Returns
Path of the created temp directory (caller is responsible for cleanup), or empty string on failure.
Note
This is a static function. Uses POSIX mkdtemp; requires a Linux/POSIX system.

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