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

Class MHO_FringeCommandLineParser. More...

#include <MHO_FringeCommandLineParser.hh>

Public Member Functions

 MHO_FringeCommandLineParser ()
 
virtual ~MHO_FringeCommandLineParser ()
 

Static Public Member Functions

static void initialize_messaging (int message_level, const std::vector< std::string > &message_categories)
 
static void parse_baseline_freqgrp (std::string baseline_freqgrp, std::string &baseline, std::string &freqgrp)
 Parses baseline_freqgrp string into separate baseline and freqgrp strings (expects ':' as separator). More...
 
static int parse_fourfit_command_line (int argc, char **argv, MHO_ParameterStore *paramStore)
 Parses command line arguments and stores them in a parameter store for later use by fourfit. More...
 
static std::string parse_set_string (const std::vector< std::string > &arglist, int &set_arg_index)
 Parses a vector of strings to extract and concatenate control file syntax after 'set' command. More...
 
static std::string sanitize_directory (std::string dir)
 Sanitizes a directory path by ensuring it ends with '/' and exists. More...
 
static int sanity_check (MHO_ParameterStore *paramStore)
 Performs a sanity check on command line parameters after parsing. More...
 

Detailed Description

Class MHO_FringeCommandLineParser.

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_FringeCommandLineParser()

hops::MHO_FringeCommandLineParser::MHO_FringeCommandLineParser ( )
inline

◆ ~MHO_FringeCommandLineParser()

virtual hops::MHO_FringeCommandLineParser::~MHO_FringeCommandLineParser ( )
inlinevirtual

Member Function Documentation

◆ initialize_messaging()

void hops::MHO_FringeCommandLineParser::initialize_messaging ( int  message_level,
const std::vector< std::string > &  message_categories 
)
static

◆ parse_baseline_freqgrp()

void hops::MHO_FringeCommandLineParser::parse_baseline_freqgrp ( std::string  baseline_freqgrp,
std::string &  baseline,
std::string &  freqgrp 
)
static

Parses baseline_freqgrp string into separate baseline and freqgrp strings (expects ':' as separator).

Parameters
baseline_freqgrpInput string containing baseline and frequency group information.
baseline(std::string&)
freqgrp(std::string&)
Note
This is a static function.

◆ parse_fourfit_command_line()

int hops::MHO_FringeCommandLineParser::parse_fourfit_command_line ( int  argc,
char **  argv,
MHO_ParameterStore paramStore 
)
static

Parses command line arguments and stores them in a parameter store for later use by fourfit.

Parameters
argcNumber of command line arguments
argvArray of command line argument strings
paramStorePointer to MHO_ParameterStore object to store parsed arguments
Returns
0 if successful, non-zero otherwise
Note
This is a static function.

◆ parse_set_string()

std::string hops::MHO_FringeCommandLineParser::parse_set_string ( const std::vector< std::string > &  arglist,
int &  set_arg_index 
)
static

Parses a vector of strings to extract and concatenate control file syntax after 'set' command.

Parameters
arglistInput vector of strings containing commands and arguments
set_arg_indexOutput index of 'set' command position in arglist
Returns
Concatenated string of control file syntax after 'set' command
Note
This is a static function.

◆ sanitize_directory()

std::string hops::MHO_FringeCommandLineParser::sanitize_directory ( std::string  dir)
static

Sanitizes a directory path by ensuring it ends with '/' and exists.

Parameters
dirInput directory path to sanitize.
Returns
Sanitized directory path (preserves symlinks).
Note
This is a static function.

◆ sanity_check()

int hops::MHO_FringeCommandLineParser::sanity_check ( MHO_ParameterStore paramStore)
static

Performs a sanity check on command line parameters after parsing.

Parameters
paramStorePointer to MHO_ParameterStore containing parsed command line arguments.
Returns
0 if parameters are valid, 1 otherwise.
Note
This is a static function.

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