Quantity.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
#ifndef ODIM_QUANTITY
#define ODIM_QUANTITY
 
#include <data/QuantitySelector.h>
#include <ostream>
 
#include <drain/util/ReferenceMap.h>
#include <drain/util/Range.h>
 
#include "EncodingODIM.h"
 
 
namespace rack {
 
 
 
 
class Quantity : public std::map<char,EncodingODIM> {
 
public:
 
    typedef std::map<char,EncodingODIM> map_t;
 
    typedef std::list<EncodingODIM> list_t;
 
    // typedef std::map<std::string,std::string> desc_map_t;
 
    std::string name;
 
    //drain::StringMatcherList<drain::StringMatcher> keySelector; // could be keyMatcher?
    //drain::StringMatcherList<FM301KeyMatcher>
    QuantitySelector keySelector; // could be keyMatcher?
 
    char defaultType = '\0';
 
    drain::Range<double> physicalRange;
 
    /*
     *  A physical value that represents all the measurement results that fall below a detection limit.
     */
    double undetectValue = std::numeric_limits<double>::signaling_NaN();
 
 
    /*
    Quantity(const std::string & name = "",
            const drain::Range<double> & range = {},
            char defaultType='\0',
            const list_t & l = {}, // brace initializer
            double undetectValue = std::numeric_limits<double>::signaling_NaN());
    */
 
    /*
    Quantity(const std::string & name,
            const std::list<std::string> & compatibleVariants,
            const drain::Range<double> & range, */
    Quantity(const std::string & name = "",
            //const std::list<std::string> & compatibleVariants = {},
            const QuantitySelector & compatibleVariants = {},
            const drain::Range<double> & range = {},
            char defaultType='\0',
            const list_t & l = {}, // brace initializer
            double undetectValue = std::numeric_limits<double>::signaling_NaN());
 
 
    Quantity(const std::string & name,
            // const std::list<std::string> & compatibleVariants,
            const QuantitySelector & compatibleVariants,
            char defaultType,
            const list_t & l = {}, // brace initializer
            double undetectValue = std::numeric_limits<double>::signaling_NaN());
 
 
    /*
    inline
    Quantity(): defaultType('\0'), undetectValue(std::numeric_limits<double>::signaling_NaN()) {
    }
    */
 
    inline
    Quantity(const Quantity & quantity):
        map_t(quantity),
        name(quantity.name),
        keySelector(quantity.keySelector),
        defaultType(quantity.defaultType),
        physicalRange(quantity.physicalRange),
        undetectValue(quantity.undetectValue) {
    }
 
    Quantity & operator=(const Quantity &) = default;
 
    /*
    inline
    Quantity & operator=(const Quantity & quantity){
        map_t::operator=(quantity);
        variants.setKeys(quantity);
        name = quantity.name;
        defaultType = quantity.defaultType;
        physicalRange = quantity.physicalRange;
        undetectValue = quantity.undetectValue;
        return *this;
    }
    */
 
    /*
     *
     *  Set defaultType, if unset.
     */
    EncodingODIM & set(char typecode);
 
    void addEncodings(const list_t & l);
 
 
    const EncodingODIM & get(char typecode = '\0') const;
 
    const EncodingODIM & get(const std::string & t) const;
 
    inline
    bool isApplicable(const std::string & key){ // needed?
        return keySelector.test(key, false);
    }
 
    inline
    bool hasUndetectValue() const {
        return !std::isnan(undetectValue);
    }
 
 
    inline
    void setZero(double value){
        undetectValue = value;
    }
 
 
    void setZero(const std::string & value);
 
    inline
    void unsetZero(){
        undetectValue = std::numeric_limits<double>::signaling_NaN();
    }
 
 
    inline
    void setPhysicalRange(double min, double max = std::numeric_limits<double>::max() ){
        // hasUndetectValue  = true;
        // undetectValue     = min;
        setZero(min);
        physicalRange.set(min, max);
    }
 
    std::ostream & toStream(std::ostream & ostr) const;
 
 
};
 
inline
std::ostream & operator<<(std::ostream & ostr, const Quantity & q){
    return q.toStream(ostr);
}
 
 
 
}  // namespace rack
 
 
#endif
 
// Rack