Skip to content

Commit

Permalink
Per #3059, rename IODA-related classes from ioadReader/iodaMetadata/i…
Browse files Browse the repository at this point in the history
…odaHeaders to IODAReader/IODAMetadata/IODAHeaders.
  • Loading branch information
JohnHalleyGotway committed Mar 10, 2025
1 parent ae9316f commit 7c8e2d5
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 45 deletions.
58 changes: 29 additions & 29 deletions src/libcode/vx_ioda/ioda.cc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ static bool has_postfix(const std::string &, std::string const &);

////////////////////////////////////////////////////////////////////////

bool iodaReader::check_missing_thresh(double value) const {
bool IODAReader::check_missing_thresh(double value) const {
bool check = false;
for(int idx=0; idx<conf_info.missing_thresh.n(); idx++) {
if(conf_info.missing_thresh[idx].check(value)) {
Expand All @@ -53,7 +53,7 @@ bool iodaReader::check_missing_thresh(double value) const {

////////////////////////////////////////////////////////////////////////

void iodaReader::clear() {
void IODAReader::clear() {
nrecs = 0;
nlocs = 0;
nvars = bad_data_int ;
Expand Down Expand Up @@ -85,7 +85,7 @@ void iodaReader::clear() {

////////////////////////////////////////////////////////////////////////

e_ioda_format iodaReader::find_ioda_format(NcFile *_f_in) {
e_ioda_format IODAReader::find_ioda_format(NcFile *_f_in) {
ioda_format = e_ioda_format::v2;

if (! has_nc_group(_f_in, obs_group_name)) ioda_format = e_ioda_format::v1;
Expand All @@ -94,10 +94,10 @@ e_ioda_format iodaReader::find_ioda_format(NcFile *_f_in) {

////////////////////////////////////////////////////////////////////////

ConcatString iodaReader::find_meta_name(const string &meta_key,
ConcatString IODAReader::find_meta_name(const string &meta_key,
const StringArray &available_names) {
ConcatString metadata_name;
static const char *method_name = "iodaReader::find_meta_name() -> ";
static const char *method_name = "IODAReader::find_meta_name() -> ";

if (available_names.has(meta_key)) metadata_name = meta_key;
else {
Expand All @@ -121,7 +121,7 @@ ConcatString iodaReader::find_meta_name(const string &meta_key,

////////////////////////////////////////////////////////////////////////

bool iodaReader::get_meta_data_chars(NcVar &var, char *metadata_buf) const {
bool IODAReader::get_meta_data_chars(NcVar &var, char *metadata_buf) const {
bool status = false;

if(IS_VALID_NC(var)) {
Expand All @@ -138,14 +138,14 @@ bool iodaReader::get_meta_data_chars(NcVar &var, char *metadata_buf) const {

////////////////////////////////////////////////////////////////////////

bool iodaReader::get_meta_data_double(const char *metadata_key, double *metadata_buf) {
bool IODAReader::get_meta_data_double(const char *metadata_key, double *metadata_buf) {
bool status = false;

ConcatString metadata_name = find_meta_name(metadata_key, metadata_vars);
if(metadata_name.nonempty()) {
NcVar meta_var = get_var(f_in, metadata_name.c_str(), metadata_group_name);
if(IS_VALID_NC(meta_var)) {
static const char *method_name = "iodaReader::get_meta_data_double() -> ";
static const char *method_name = "IODAReader::get_meta_data_double() -> ";
status = get_nc_data(&meta_var, metadata_buf, nlocs);
if (!status) mlog << Debug(3) << method_name
<< "trouble getting " << metadata_name << "\n";
Expand All @@ -165,8 +165,8 @@ bool iodaReader::get_meta_data_double(const char *metadata_key, double *metadata

////////////////////////////////////////////////////////////////////////

void iodaReader::get_obs_metadata_names_v1() {
static const char *method_name = "iodaReader::get_obs_metadata_names_v1() -> ";
void IODAReader::get_obs_metadata_names_v1() {
static const char *method_name = "IODAReader::get_obs_metadata_names_v1() -> ";
bool error_out = true;

StringArray var_names;
Expand Down Expand Up @@ -203,7 +203,7 @@ void iodaReader::get_obs_metadata_names_v1() {

////////////////////////////////////////////////////////////////////////

void iodaReader::get_obs_metadata_names_v2() {
void IODAReader::get_obs_metadata_names_v2() {
StringArray group_names;
group_names.add(metadata_group_name);
get_var_names(f_in, &metadata_vars, group_names);
Expand All @@ -215,7 +215,7 @@ void iodaReader::get_obs_metadata_names_v2() {

////////////////////////////////////////////////////////////////////////

vector<point_pair_t> *iodaReader::get_point_pairs(
vector<point_pair_t> *IODAReader::get_point_pairs(
const char *var_name_f, const char *var_name_o,
const char *group_name_f, const char *group_name_o, const int channel) {
ConcatString log_var_name_f = var_name_f;
Expand Down Expand Up @@ -251,7 +251,7 @@ vector<point_pair_t> *iodaReader::get_point_pairs(

////////////////////////////////////////////////////////////////////////

bool iodaReader::is_in_metadata_map(const string &metadata_key,
bool IODAReader::is_in_metadata_map(const string &metadata_key,
const StringArray &available_list) {
bool found = available_list.has(metadata_key);

Expand All @@ -269,8 +269,8 @@ bool iodaReader::is_in_metadata_map(const string &metadata_key,

////////////////////////////////////////////////////////////////////////

void iodaReader::read_header() {
static const char *method_name = "iodaReader::read_header() -> ";
void IODAReader::read_header() {
static const char *method_name = "IODAReader::read_header() -> ";

if (!read_time()) {
clear();
Expand Down Expand Up @@ -329,11 +329,11 @@ void iodaReader::read_header() {

////////////////////////////////////////////////////////////////////////

bool iodaReader::read_time() {
bool IODAReader::read_time() {
bool status = false;
bool error_out = true;
static const char *method_name = "iodaReader::read_time() -> ";
static const char *method_name_s = "iodaReader::read_time() ";
static const char *method_name = "IODAReader::read_time() -> ";
static const char *method_name_s = "IODAReader::read_time() ";

NcVar in_hdr_vld_var = get_var(f_in, datetime_name.c_str(), metadata_group_name);
if (IS_INVALID_NC(in_hdr_vld_var)) {
Expand Down Expand Up @@ -394,9 +394,9 @@ bool iodaReader::read_time() {

////////////////////////////////////////////////////////////////////////

bool iodaReader::read_time_as_number(NcVar *hdr_vld_var) {
bool IODAReader::read_time_as_number(NcVar *hdr_vld_var) {
bool status = false;
static const char *method_name = "iodaReader::read_time_as_number() -> ";
static const char *method_name = "IODAReader::read_time_as_number() -> ";

unixtime base_ut;
int sec_per_unit;
Expand Down Expand Up @@ -438,8 +438,8 @@ bool iodaReader::read_time_as_number(NcVar *hdr_vld_var) {

////////////////////////////////////////////////////////////////////////

void iodaReader::read_ioda(netCDF::NcFile *_f_in) {
static const char *method_name = "iodaReader::read_ioda() -> ";
void IODAReader::read_ioda(netCDF::NcFile *_f_in) {
static const char *method_name = "IODAReader::read_ioda() -> ";
bool error_out = true;

f_in = _f_in;
Expand Down Expand Up @@ -486,7 +486,7 @@ void iodaReader::read_ioda(netCDF::NcFile *_f_in) {

////////////////////////////////////////////////////////////////////////

void iodaReader::read_metadata_names() {
void IODAReader::read_metadata_names() {
datetime_name = find_meta_name(conf_key_datetime, metadata_vars);
lon_name = find_meta_name("longitude", metadata_vars);
lat_name = find_meta_name("latitude", metadata_vars);
Expand All @@ -496,11 +496,11 @@ void iodaReader::read_metadata_names() {

////////////////////////////////////////////////////////////////////////

bool iodaReader::read_obs_data(double *data_buf, const char *var_name,
bool IODAReader::read_obs_data(double *data_buf, const char *var_name,
const char *group_name, const int channel) {
bool status = false;
ConcatString log_var_name = var_name;
static const char *method_name = "iodaReader::read_obs_data -> ";
static const char *method_name = "IODAReader::read_obs_data -> ";

if (group_name) {
log_var_name.add("(");
Expand Down Expand Up @@ -568,11 +568,11 @@ bool iodaReader::read_obs_data(double *data_buf, const char *var_name,

////////////////////////////////////////////////////////////////////////

bool iodaReader::read_string_data(const char *var_name, vector<string> &hdr_data, int str_length) {
bool IODAReader::read_string_data(const char *var_name, vector<string> &hdr_data, int str_length) {
bool status = false;
char hdr_val[512];
static const char *method_name = "iodaReader::read_string_data -> ";
static const char *method_name_s = "iodaReader::read_string_data() ";
static const char *method_name = "IODAReader::read_string_data -> ";
static const char *method_name_s = "IODAReader::read_string_data() ";

hdr_data.clear();
NcVar hdr_var = get_var(f_in, var_name, metadata_group_name);
Expand Down Expand Up @@ -610,7 +610,7 @@ bool iodaReader::read_string_data(const char *var_name, vector<string> &hdr_data

////////////////////////////////////////////////////////////////////////

void iodaReader::set_data_config(const char *default_file_name,
void IODAReader::set_data_config(const char *default_file_name,
const char *user_file_name) {
// Read the config files
conf_info.read_data_config(default_file_name, user_file_name);
Expand Down
24 changes: 11 additions & 13 deletions src/libcode/vx_ioda/ioda.h
Original file line number Diff line number Diff line change
@@ -1,42 +1,43 @@

// *=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*
// ** Copyright UCAR (c) 1992 - 2025
// ** University Corporation for Atmospheric Research (UCAR)
// ** National Center for Atmospheric Research (NCAR)
// ** Research Applications Lab (RAL)
// ** P.O.Box 3000, Boulder, Colorado, 80307-3000, USA
// *=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*=*

////////////////////////////////////////////////////////////////////////


#ifndef __IODA_H__
#define __IODA_H__


////////////////////////////////////////////////////////////////////////

#include <netcdf>

#include "pair_base.h"
#include "ioda_data_conf_info.h"

////////////////////////////////////////////////////////////////////////


////////////////////////////////////////////////////////////////////////

enum class e_ioda_format { v1, v2 };

////////////////////////////////////////////////////////////////////////

struct iodaHeaders {
struct IODAHeaders {
void clear();
};

////////////////////////////////////////////////////////////////////////

struct iodaMetadata {
struct IODAMetadata {

void clear();
};

////////////////////////////////////////////////////////////////////////

class iodaReader {
class IODAReader {
public:

int nlocs;
Expand Down Expand Up @@ -104,15 +105,12 @@ class iodaReader {

};


////////////////////////////////////////////////////////////////////////

inline e_ioda_format iodaReader::get_format_ver() const { return ioda_format; };
inline e_ioda_format IODAReader::get_format_ver() const { return ioda_format; };

////////////////////////////////////////////////////////////////////////

#endif /* __IODA_H__ */


////////////////////////////////////////////////////////////////////////

7 changes: 4 additions & 3 deletions src/tools/other/ioda2nc/ioda2nc.cc
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@
#include <netcdf>

#include "main.h"
#include "apply_mask.h"
#include "ioda.h"
#include "ioda2nc_conf_info.h"

#include "apply_mask.h"
#include "vx_ioda.h"
#include "vx_log.h"
#include "vx_nc_util.h"
#include "vx_util.h"
Expand Down Expand Up @@ -71,7 +72,7 @@ static constexpr char program_name[] = "ioda2nc";
// Variables for command line arguments
//

static iodaReader ioda_reader;
static IODAReader ioda_reader;

// StringArray to store IODA file name
static StringArray ioda_files;
Expand Down

0 comments on commit 7c8e2d5

Please sign in to comment.