// *=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=* // ** Copyright UCAR (c) 1992 - 2019 // ** University Corporation for Atmospheric Research(UCAR) // ** National Center for Atmospheric Research(NCAR) // ** Boulder, Colorado, USA // *=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=* //////////////////////////////////////////// // Params.cc // // TDRP C++ code file for class 'Params'. // // Code for program PrecipAccumCalc // // This file has been automatically // generated by TDRP, do not modify. // ///////////////////////////////////////////// /** * * @file Params.cc * * @class Params * * This class is automatically generated by the Table * Driven Runtime Parameters (TDRP) system * * @note Source is automatically generated from * paramdef file at compile time, do not modify * since modifications will be overwritten. * * * @author Automatically generated * */ using namespace std; #include "Params.hh" #include //////////////////////////////////////////// // Default constructor // Params::Params() { // zero out table memset(_table, 0, sizeof(_table)); // zero out members memset(&_start_, 0, &_end_ - &_start_); // class name _className = "Params"; // initialize table _init(); // set members tdrpTable2User(_table, &_start_); _exitDeferred = false; } //////////////////////////////////////////// // Copy constructor // Params::Params(const Params& source) { // sync the source object source.sync(); // zero out table memset(_table, 0, sizeof(_table)); // zero out members memset(&_start_, 0, &_end_ - &_start_); // class name _className = "Params"; // copy table tdrpCopyTable((TDRPtable *) source._table, _table); // set members tdrpTable2User(_table, &_start_); _exitDeferred = false; } //////////////////////////////////////////// // Destructor // Params::~Params() { // free up freeAll(); } //////////////////////////////////////////// // Assignment // void Params::operator=(const Params& other) { // sync the other object other.sync(); // free up any existing memory freeAll(); // zero out table memset(_table, 0, sizeof(_table)); // zero out members memset(&_start_, 0, &_end_ - &_start_); // copy table tdrpCopyTable((TDRPtable *) other._table, _table); // set members tdrpTable2User(_table, &_start_); _exitDeferred = other._exitDeferred; } //////////////////////////////////////////// // loadFromArgs() // // Loads up TDRP using the command line args. // // Check usage() for command line actions associated with // this function. // // argc, argv: command line args // // char **override_list: A null-terminated list of overrides // to the parameter file. // An override string has exactly the format of an entry // in the parameter file itself. // // char **params_path_p: // If this is non-NULL, it is set to point to the path // of the params file used. // // bool defer_exit: normally, if the command args contain a // print or check request, this function will call exit(). // If defer_exit is set, such an exit is deferred and the // private member _exitDeferred is set. // Use exidDeferred() to test this flag. // // Returns 0 on success, -1 on failure. // int Params::loadFromArgs(int argc, char **argv, char **override_list, char **params_path_p, bool defer_exit) { int exit_deferred; if (_tdrpLoadFromArgs(argc, argv, _table, &_start_, override_list, params_path_p, _className, defer_exit, &exit_deferred)) { return (-1); } else { if (exit_deferred) { _exitDeferred = true; } return (0); } } //////////////////////////////////////////// // loadApplyArgs() // // Loads up TDRP using the params path passed in, and applies // the command line args for printing and checking. // // Check usage() for command line actions associated with // this function. // // const char *param_file_path: the parameter file to be read in // // argc, argv: command line args // // char **override_list: A null-terminated list of overrides // to the parameter file. // An override string has exactly the format of an entry // in the parameter file itself. // // bool defer_exit: normally, if the command args contain a // print or check request, this function will call exit(). // If defer_exit is set, such an exit is deferred and the // private member _exitDeferred is set. // Use exidDeferred() to test this flag. // // Returns 0 on success, -1 on failure. // int Params::loadApplyArgs(const char *params_path, int argc, char **argv, char **override_list, bool defer_exit) { int exit_deferred; if (tdrpLoadApplyArgs(params_path, argc, argv, _table, &_start_, override_list, _className, defer_exit, &exit_deferred)) { return (-1); } else { if (exit_deferred) { _exitDeferred = true; } return (0); } } //////////////////////////////////////////// // isArgValid() // // Check if a command line arg is a valid TDRP arg. // bool Params::isArgValid(const char *arg) { return (tdrpIsArgValid(arg)); } //////////////////////////////////////////// // load() // // Loads up TDRP for a given class. // // This version of load gives the programmer the option to load // up more than one class for a single application. It is a // lower-level routine than loadFromArgs, and hence more // flexible, but the programmer must do more work. // // const char *param_file_path: the parameter file to be read in. // // char **override_list: A null-terminated list of overrides // to the parameter file. // An override string has exactly the format of an entry // in the parameter file itself. // // expand_env: flag to control environment variable // expansion during tokenization. // If TRUE, environment expansion is set on. // If FALSE, environment expansion is set off. // // Returns 0 on success, -1 on failure. // int Params::load(const char *param_file_path, char **override_list, int expand_env, int debug) { if (tdrpLoad(param_file_path, _table, &_start_, override_list, expand_env, debug)) { return (-1); } else { return (0); } } //////////////////////////////////////////// // loadFromBuf() // // Loads up TDRP for a given class. // // This version of load gives the programmer the option to // load up more than one module for a single application, // using buffers which have been read from a specified source. // // const char *param_source_str: a string which describes the // source of the parameter information. It is used for // error reporting only. // // char **override_list: A null-terminated list of overrides // to the parameter file. // An override string has exactly the format of an entry // in the parameter file itself. // // const char *inbuf: the input buffer // // int inlen: length of the input buffer // // int start_line_num: the line number in the source which // corresponds to the start of the buffer. // // expand_env: flag to control environment variable // expansion during tokenization. // If TRUE, environment expansion is set on. // If FALSE, environment expansion is set off. // // Returns 0 on success, -1 on failure. // int Params::loadFromBuf(const char *param_source_str, char **override_list, const char *inbuf, int inlen, int start_line_num, int expand_env, int debug) { if (tdrpLoadFromBuf(param_source_str, _table, &_start_, override_list, inbuf, inlen, start_line_num, expand_env, debug)) { return (-1); } else { return (0); } } //////////////////////////////////////////// // loadDefaults() // // Loads up default params for a given class. // // See load() for more detailed info. // // Returns 0 on success, -1 on failure. // int Params::loadDefaults(int expand_env) { if (tdrpLoad(NULL, _table, &_start_, NULL, expand_env, FALSE)) { return (-1); } else { return (0); } } //////////////////////////////////////////// // sync() // // Syncs the user struct data back into the parameter table, // in preparation for printing. // // This function alters the table in a consistent manner. // Therefore it can be regarded as const. // void Params::sync(void) const { tdrpUser2Table(_table, (char *) &_start_); } //////////////////////////////////////////// // print() // // Print params file // // The modes supported are: // // PRINT_SHORT: main comments only, no help or descriptions // structs and arrays on a single line // PRINT_NORM: short + descriptions and help // PRINT_LONG: norm + arrays and structs expanded // PRINT_VERBOSE: long + private params included // void Params::print(FILE *out, tdrp_print_mode_t mode) { tdrpPrint(out, _table, _className, mode); } //////////////////////////////////////////// // checkAllSet() // // Return TRUE if all set, FALSE if not. // // If out is non-NULL, prints out warning messages for those // parameters which are not set. // int Params::checkAllSet(FILE *out) { return (tdrpCheckAllSet(out, _table, &_start_)); } ////////////////////////////////////////////////////////////// // checkIsSet() // // Return TRUE if parameter is set, FALSE if not. // // int Params::checkIsSet(const char *paramName) { return (tdrpCheckIsSet(paramName, _table, &_start_)); } //////////////////////////////////////////// // freeAll() // // Frees up all TDRP dynamic memory. // void Params::freeAll(void) { tdrpFreeAll(_table, &_start_); } //////////////////////////////////////////// // usage() // // Prints out usage message for TDRP args as passed // in to loadFromArgs(). // void Params::usage(ostream &out) { out << "TDRP args: [options as below]\n" << " [ -params/--params path ] specify params file path\n" << " [ -check_params/--check_params] check which params are not set\n" << " [ -print_params/--print_params [mode]] print parameters\n" << " using following modes, default mode is 'norm'\n" << " short: main comments only, no help or descr\n" << " structs and arrays on a single line\n" << " norm: short + descriptions and help\n" << " long: norm + arrays and structs expanded\n" << " verbose: long + private params included\n" << " short_expand: short with env vars expanded\n" << " norm_expand: norm with env vars expanded\n" << " long_expand: long with env vars expanded\n" << " verbose_expand: verbose with env vars expanded\n" << " [ -tdrp_debug] debugging prints for tdrp\n" << " [ -tdrp_usage] print this usage\n"; } //////////////////////////////////////////// // arrayRealloc() // // Realloc 1D array. // // If size is increased, the values from the last array // entry is copied into the new space. // // Returns 0 on success, -1 on error. // int Params::arrayRealloc(const char *param_name, int new_array_n) { if (tdrpArrayRealloc(_table, &_start_, param_name, new_array_n)) { return (-1); } else { return (0); } } //////////////////////////////////////////// // array2DRealloc() // // Realloc 2D array. // // If size is increased, the values from the last array // entry is copied into the new space. // // Returns 0 on success, -1 on error. // int Params::array2DRealloc(const char *param_name, int new_array_n1, int new_array_n2) { if (tdrpArray2DRealloc(_table, &_start_, param_name, new_array_n1, new_array_n2)) { return (-1); } else { return (0); } } //////////////////////////////////////////// // _init() // // Class table initialization function. // // void Params::_init() { TDRPtable *tt = _table; // Parameter 'Comment 0' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = COMMENT_TYPE; tt->param_name = tdrpStrDup("Comment 0"); tt->comment_hdr = tdrpStrDup("PrecipAccumCalc "); tt->comment_text = tdrpStrDup(""); tt++; // Parameter 'Comment 1' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = COMMENT_TYPE; tt->param_name = tdrpStrDup("Comment 1"); tt->comment_hdr = tdrpStrDup("Reads model mdv input with 3 hr accmulations at alternating lead times and produces 3hr accumulations at every lead time"); tt->comment_text = tdrpStrDup(""); tt++; // Parameter 'runMode' // ctype is '_run_mode_t' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = ENUM_TYPE; tt->param_name = tdrpStrDup("runMode"); tt->descr = tdrpStrDup(""); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &runMode - &_start_; tt->enum_def.name = tdrpStrDup("run_mode_t"); tt->enum_def.nfields = 2; tt->enum_def.fields = (enum_field_t *) tdrpMalloc(tt->enum_def.nfields * sizeof(enum_field_t)); tt->enum_def.fields[0].name = tdrpStrDup("REALTIME"); tt->enum_def.fields[0].val = REALTIME; tt->enum_def.fields[1].name = tdrpStrDup("ARCHIVE"); tt->enum_def.fields[1].val = ARCHIVE; tt->single_val.e = REALTIME; tt++; // Parameter 'outputDataType' // ctype is '_ouput_data_type_t' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = ENUM_TYPE; tt->param_name = tdrpStrDup("outputDataType"); tt->descr = tdrpStrDup(""); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &outputDataType - &_start_; tt->enum_def.name = tdrpStrDup("ouput_data_type_t"); tt->enum_def.nfields = 3; tt->enum_def.fields = (enum_field_t *) tdrpMalloc(tt->enum_def.nfields * sizeof(enum_field_t)); tt->enum_def.fields[0].name = tdrpStrDup("INT8"); tt->enum_def.fields[0].val = INT8; tt->enum_def.fields[1].name = tdrpStrDup("INT16"); tt->enum_def.fields[1].val = INT16; tt->enum_def.fields[2].name = tdrpStrDup("FLOAT32"); tt->enum_def.fields[2].val = FLOAT32; tt->single_val.e = FLOAT32; tt++; // Parameter 'ensembleMembers' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("ensembleMembers"); tt->descr = tdrpStrDup(""); tt->help = tdrpStrDup(""); tt->array_offset = (char *) &_ensembleMembers - &_start_; tt->array_n_offset = (char *) &ensembleMembers_n - &_start_; tt->is_array = TRUE; tt->array_len_fixed = FALSE; tt->array_elem_size = sizeof(char*); tt->array_n = 20; tt->array_vals = (tdrpVal_t *) tdrpMalloc(tt->array_n * sizeof(tdrpVal_t)); tt->array_vals[0].s = tdrpStrDup("gep01"); tt->array_vals[1].s = tdrpStrDup("gep02"); tt->array_vals[2].s = tdrpStrDup("gep03"); tt->array_vals[3].s = tdrpStrDup("gep04"); tt->array_vals[4].s = tdrpStrDup("gep05"); tt->array_vals[5].s = tdrpStrDup("gep06"); tt->array_vals[6].s = tdrpStrDup("gep07"); tt->array_vals[7].s = tdrpStrDup("gep08"); tt->array_vals[8].s = tdrpStrDup("gep09"); tt->array_vals[9].s = tdrpStrDup("gep10"); tt->array_vals[10].s = tdrpStrDup("gep11"); tt->array_vals[11].s = tdrpStrDup("gep12"); tt->array_vals[12].s = tdrpStrDup("gep13"); tt->array_vals[13].s = tdrpStrDup("gep14"); tt->array_vals[14].s = tdrpStrDup("gep15"); tt->array_vals[15].s = tdrpStrDup("gep16"); tt->array_vals[16].s = tdrpStrDup("gep17"); tt->array_vals[17].s = tdrpStrDup("gep18"); tt->array_vals[18].s = tdrpStrDup("gep19"); tt->array_vals[19].s = tdrpStrDup("gep20"); tt++; // Parameter 'hr3AccumName' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("hr3AccumName"); tt->descr = tdrpStrDup("3 hour accum input short field name. (output has same name)"); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &hr3AccumName - &_start_; tt->single_val.s = tdrpStrDup("APCP3Hr"); tt++; // Parameter 'hr3AccumOutputDirTail' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("hr3AccumOutputDirTail"); tt->descr = tdrpStrDup("3 hour accumulation string to be appended to output url."); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &hr3AccumOutputDirTail - &_start_; tt->single_val.s = tdrpStrDup("3hrAccum"); tt++; // Parameter 'hr6AccumName' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("hr6AccumName"); tt->descr = tdrpStrDup("6 hour accum input field name. (not output)"); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &hr6AccumName - &_start_; tt->single_val.s = tdrpStrDup("APCP6Hr"); tt++; // Parameter 'hr3UlwrfName' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("hr3UlwrfName"); tt->descr = tdrpStrDup("3 hour ULWRF average field name, input (output has same name)."); tt->help = tdrpStrDup("2*ULWRF6Hr(lead i) -ULWRF3Hr (lead i-1 ) will be calculated to form ULWRF3Hr (lead i) with output field name the same as the input 3hr field "); tt->val_offset = (char *) &hr3UlwrfName - &_start_; tt->single_val.s = tdrpStrDup("ULWRF3Hr"); tt++; // Parameter 'hr6UlwrfName' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("hr6UlwrfName"); tt->descr = tdrpStrDup("6 hour ULWRF average field name, input."); tt->help = tdrpStrDup("2*ULWRF6Hr(lead i) - ULWRF3Hr (lead i-1) will be calculated to form ULWRF3Hr (lead i) with output field name hr3UlwrfName as above "); tt->val_offset = (char *) &hr6UlwrfName - &_start_; tt->single_val.s = tdrpStrDup("ULWRF6Hr"); tt++; // Parameter 'extraDataFields' // ctype is 'char*' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRING_TYPE; tt->param_name = tdrpStrDup("extraDataFields"); tt->descr = tdrpStrDup("Other data fields in the mdv file which will be appended to any new file created"); tt->help = tdrpStrDup(""); tt->array_offset = (char *) &_extraDataFields - &_start_; tt->array_n_offset = (char *) &extraDataFields_n - &_start_; tt->is_array = TRUE; tt->array_len_fixed = FALSE; tt->array_elem_size = sizeof(char*); tt->array_n = 0; tt->array_vals = (tdrpVal_t *) tdrpMalloc(tt->array_n * sizeof(tdrpVal_t)); tt++; // Parameter 'forceAccumNonNegative' // ctype is 'tdrp_bool_t' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = BOOL_TYPE; tt->param_name = tdrpStrDup("forceAccumNonNegative"); tt->descr = tdrpStrDup("Option to convert negative numbers great than -1 to zero after subtraction of fields"); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &forceAccumNonNegative - &_start_; tt->single_val.b = pTRUE; tt++; // Parameter 'numThreads' // ctype is 'int' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = INT_TYPE; tt->param_name = tdrpStrDup("numThreads"); tt->descr = tdrpStrDup("Number of threads processing the data"); tt->help = tdrpStrDup(""); tt->val_offset = (char *) &numThreads - &_start_; tt->single_val.i = 1; tt++; // Parameter 'mdv_3hr_names' // ctype is '_Mdv_name_t' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRUCT_TYPE; tt->param_name = tdrpStrDup("mdv_3hr_names"); tt->descr = tdrpStrDup("mapping of MDV field names from short to long, 3 hour averages"); tt->help = tdrpStrDup("When using server, long names are needed to do the reading"); tt->array_offset = (char *) &_mdv_3hr_names - &_start_; tt->array_n_offset = (char *) &mdv_3hr_names_n - &_start_; tt->is_array = TRUE; tt->array_len_fixed = FALSE; tt->array_elem_size = sizeof(Mdv_name_t); tt->array_n = 3; tt->struct_def.name = tdrpStrDup("Mdv_name_t"); tt->struct_def.nfields = 2; tt->struct_def.fields = (struct_field_t *) tdrpMalloc(tt->struct_def.nfields * sizeof(struct_field_t)); tt->struct_def.fields[0].ftype = tdrpStrDup("string"); tt->struct_def.fields[0].fname = tdrpStrDup("shortName"); tt->struct_def.fields[0].ptype = STRING_TYPE; tt->struct_def.fields[0].rel_offset = (char *) &_mdv_3hr_names->shortName - (char *) _mdv_3hr_names; tt->struct_def.fields[1].ftype = tdrpStrDup("string"); tt->struct_def.fields[1].fname = tdrpStrDup("longName"); tt->struct_def.fields[1].ptype = STRING_TYPE; tt->struct_def.fields[1].rel_offset = (char *) &_mdv_3hr_names->longName - (char *) _mdv_3hr_names; tt->n_struct_vals = 6; tt->struct_vals = (tdrpVal_t *) tdrpMalloc(tt->n_struct_vals * sizeof(tdrpVal_t)); tt->struct_vals[0].s = tdrpStrDup("APCP3Hr"); tt->struct_vals[1].s = tdrpStrDup("Total precipitation"); tt->struct_vals[2].s = tdrpStrDup("CAPE"); tt->struct_vals[3].s = tdrpStrDup("Convective Available Potential Energy"); tt->struct_vals[4].s = tdrpStrDup("ULWRF3Hr"); tt->struct_vals[5].s = tdrpStrDup("Unknown local use paramater number"); tt++; // Parameter 'mdv_6hr_names' // ctype is '_Mdv_name_t' memset(tt, 0, sizeof(TDRPtable)); tt->ptype = STRUCT_TYPE; tt->param_name = tdrpStrDup("mdv_6hr_names"); tt->descr = tdrpStrDup("mapping of MDV field names from short to long, 6 hour averages"); tt->help = tdrpStrDup("When using server, long names are needed to do the reading"); tt->array_offset = (char *) &_mdv_6hr_names - &_start_; tt->array_n_offset = (char *) &mdv_6hr_names_n - &_start_; tt->is_array = TRUE; tt->array_len_fixed = FALSE; tt->array_elem_size = sizeof(Mdv_name_t); tt->array_n = 3; tt->struct_def.name = tdrpStrDup("Mdv_name_t"); tt->struct_def.nfields = 2; tt->struct_def.fields = (struct_field_t *) tdrpMalloc(tt->struct_def.nfields * sizeof(struct_field_t)); tt->struct_def.fields[0].ftype = tdrpStrDup("string"); tt->struct_def.fields[0].fname = tdrpStrDup("shortName"); tt->struct_def.fields[0].ptype = STRING_TYPE; tt->struct_def.fields[0].rel_offset = (char *) &_mdv_6hr_names->shortName - (char *) _mdv_6hr_names; tt->struct_def.fields[1].ftype = tdrpStrDup("string"); tt->struct_def.fields[1].fname = tdrpStrDup("longName"); tt->struct_def.fields[1].ptype = STRING_TYPE; tt->struct_def.fields[1].rel_offset = (char *) &_mdv_6hr_names->longName - (char *) _mdv_6hr_names; tt->n_struct_vals = 6; tt->struct_vals = (tdrpVal_t *) tdrpMalloc(tt->n_struct_vals * sizeof(tdrpVal_t)); tt->struct_vals[0].s = tdrpStrDup("APCP6Hr"); tt->struct_vals[1].s = tdrpStrDup("Total precipitation"); tt->struct_vals[2].s = tdrpStrDup("CAPE"); tt->struct_vals[3].s = tdrpStrDup("Convective Available Potential Energy"); tt->struct_vals[4].s = tdrpStrDup("ULWRF6Hr"); tt->struct_vals[5].s = tdrpStrDup("Unknown local use paramater number"); tt++; // trailing entry has param_name set to NULL tt->param_name = NULL; return; }