AttributeDescription.hpp

#pragma once
 
#include "opals/config.hpp"
#include "opals/String.hpp"
 
namespace opals
{
  /// \brief  AttributeDescription provides generic information about a single attribute (used by DataSetStats).
  ///
  /// Beside the name, type, storage size (in bytes) and a nodata indicator of the attribute the 
  /// class provides basic statistic information such as min, max, mean and the standard deviation.
  /// If a specific information is really set, can be retrieved by the corresponding isSet function. 
  /// Depending on the data type a specific no data value is used to indicate unset values.
  ///           
  /// \author JO
  /// \date   24.05.2012
  class OPALS_API AttributeDescription
  {
  public:
    AttributeDescription();
    virtual ~AttributeDescription();
 
    bool isSetName() const;
    bool isSetType() const;
    bool isSetStorageSize() const;
    bool isSetCount() const;
    bool isSetMin() const;
    bool isSetMax() const;
    bool isSetMean() const;
    bool isSetStd() const;
    bool isSetNoDataIndicator() const;
 
    String    getName() const;            ///< get attribute name
    String    getType() const;            ///< get attribute type
    unsigned  getStorageSize() const;     ///< storage size of attribute in bytes
    long long getCount() const;           ///< number of elements
    double    getMin() const;             ///< minimum attribute value
    double    getMax() const;             ///< maximum attribute value
    double    getMean() const;            ///< mean attribute value
    double    getStd() const;             ///< standard deviation
    double    getNoDataIndicator() const; ///< no value indicator 
 
    void reset();
    void setAttributeDescription(const String& Name,const String& Type,const unsigned& StorageSize,const long long& Count,
                                 const double& Min,const double& Max,const double& Mean,const double& Std, const double& NoData);
    void setName(const String& Name);
    void setType(const String& Type);
    void setStorageSize(const unsigned& StorageSize);
    void setCount(const long long& Count);
    void setMin(const double& Min);
    void setMax(const double& Max);
    void setMean(const double& Mean);
    void setStd(const double& Std);
    void setNoDataIndicator(const double& NoData);
 
    // output functions
    String logAttributeDescription() const;   ///< for xml output
    String printAttributeDescription() const; ///< for log output (in more readable format)
    static String printAttributeHeader(); ///< for log the header line 
 
  private:
      String    name;
      String    type;
      unsigned  storageSize;
      long long count;
      double    min;
      double    max;
      double    mean;
      double    std;
      double    nodataIndicator;
  };
}