compositearguments.h

Go to the documentation of this file.

/* --------------------------------------------------------------------
Copyright (C) 2024 Swedish Meteorological and Hydrological Institute, SMHI,
 
This file is part of RAVE.
 
RAVE is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
 
RAVE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with RAVE.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------*/
#ifndef COMPOSITE_ARGUMENTS_H
#define COMPOSITE_ARGUMENTS_H
#include "rave_proj.h"
#include "area.h"
#include "projection.h"
#include "rave_object.h"
#include "rave_datetime.h"
#include "rave_attribute.h"
#include "raveobject_list.h"
#include "raveobject_hashtable.h"
#include "odim_sources.h"

typedef struct _CompositeArguments_t CompositeArguments_t;

extern RaveCoreObjectType CompositeArguments_TYPE;

typedef enum Rave_CompositingProduct {
  Rave_CompositingProduct_PPI,    
  Rave_CompositingProduct_CAPPI,  
  Rave_CompositingProduct_PCAPPI, 
  Rave_CompositingProduct_ETOP,   
  Rave_CompositingProduct_MAX,    
  Rave_CompositingProduct_RR,     
  Rave_CompositingProduct_PMAX,   
  Rave_CompositingProduct_ACQVA,  
  Rave_CompositingProduct_UNDEFINED  
} Rave_CompositingProduct;
 

const char* CompositeArguments_productToString(Rave_CompositingProduct product);

Rave_CompositingProduct CompositeArguments_stringToProduct(const char* product);

int CompositeArguments_setProduct(CompositeArguments_t* args, const char* product);

const char* CompositeArguments_getProduct(CompositeArguments_t* args);

Rave_CompositingProduct CompositeArguments_getCompositingProduct(CompositeArguments_t* args);

Rave_ProductType CompositeArguments_getProductType(CompositeArguments_t* args);

int CompositeArguments_setArea(CompositeArguments_t* args, Area_t* area);

Area_t* CompositeArguments_getArea(CompositeArguments_t* args);

int CompositeArguments_setTime(CompositeArguments_t* args, const char* value);

const char* CompositeArguments_getTime(CompositeArguments_t* args);

int CompositeArguments_setDate(CompositeArguments_t* args, const char* value);

const char* CompositeArguments_getDate(CompositeArguments_t* args);

void CompositeArguments_setHeight(CompositeArguments_t* args, double height);

double CompositeArguments_getHeight(CompositeArguments_t* args);

void CompositeArguments_setElevationAngle(CompositeArguments_t* args, double angle);

double CompositeArguments_getElevationAngle(CompositeArguments_t* args);

void CompositeArguments_setRange(CompositeArguments_t* args, double range);

double CompositeArguments_getRange(CompositeArguments_t* args);

int CompositeArguments_setStrategy(CompositeArguments_t* args, const char* strategy);

const char* CompositeArguments_getStrategy(CompositeArguments_t* args);

int CompositeArguments_addArgument(CompositeArguments_t* args, RaveAttribute_t* argument);

void CompositeArguments_removeArgument(CompositeArguments_t* args, const char* name);

RaveAttribute_t* CompositeArguments_getArgument(CompositeArguments_t* args, const char* name);

int CompositeArguments_hasArgument(CompositeArguments_t* args, const char* name);

int CompositeArguments_addParameter(CompositeArguments_t* args, const char* quantity, double gain, double offset, RaveDataType datatype, double nodata, double undetect);

int CompositeArguments_hasParameter(CompositeArguments_t* args, const char* quantity);

int CompositeArguments_getParameter(CompositeArguments_t* args, const char* parameter, double* gain, double* offset, RaveDataType* datatype, double* nodata, double* undetect);

int CompositeArguments_getParameterCount(CompositeArguments_t* args);

const char* CompositeArguments_getParameterAtIndex(CompositeArguments_t* args, int index, double* gain, double* offset, RaveDataType* datatype, double* nodata, double* undetect);

const char* CompositeArguments_getParameterName(CompositeArguments_t* args, int index);

int CompositeArguments_addObject(CompositeArguments_t* args, RaveCoreObject* object);

int CompositeArguments_getNumberOfObjects(CompositeArguments_t* args);

RaveCoreObject* CompositeArguments_getObject(CompositeArguments_t* args, int index);

RaveObjectList_t* CompositeArguments_getObjects(CompositeArguments_t* args);

int CompositeArguments_getObjectRadarIndexValue(CompositeArguments_t* args, int index);

int CompositeArguments_setQIFieldName(CompositeArguments_t* args, const char* fieldname);

const char* CompositeArguments_getQIFieldName(CompositeArguments_t* args);

int CompositeArguments_addQualityFlag(CompositeArguments_t* args, const char* flag);

int CompositeArguments_setQualityFlags(CompositeArguments_t* args, const char* flags[], int nrflags);

int CompositeArguments_removeQualityFlag(CompositeArguments_t* args, const char* flag);

int CompositeArguments_removeQualityFlagAt(CompositeArguments_t* args, int index);

int CompositeArguments_getNumberOfQualityFlags(CompositeArguments_t* args);

const char* CompositeArguments_getQualityFlagAt(CompositeArguments_t* args, int index);

RaveList_t* CompositeArguments_getQualityFlags(CompositeArguments_t* args);

int CompositeArguments_hasQualityFlag(CompositeArguments_t* args, const char* name);

int CompositeArguments_createRadarIndexMapping(CompositeArguments_t* args, OdimSources_t* sources);

RaveObjectHashTable_t* CompositeArguments_getRadarIndexMapping(CompositeArguments_t* args);

int CompositeArguments_updateRadarIndexMapping(CompositeArguments_t* args, RaveObjectHashTable_t* mapping, OdimSources_t* sources);

RaveList_t* CompositeArguments_getRadarIndexKeys(CompositeArguments_t* args);

int CompositeArguments_getRadarIndexValue(CompositeArguments_t* args, const char* key);

int CompositeArguments_createRadarIndex(CompositeArguments_t* args, const char* key);
 
#endif /* COMPOSITE_ARGUMENTS_H */