MetadataUtils.h

Go to the documentation of this file.

#ifndef INC_netCDF_MetadataUtils_h
#define INC_netCDF_MetadataUtils_h

#include "metadata/MetadataCFVariable.h"
#include "metadata/NcVarMetaCF.h"
#include "metadata/MetadataCFGlobal.h"
#include "metadata/NcFileMetaCF.h"
#include <ostream>

namespace netcdf {


template< typename TNumeric >
void operator<< (
    NcVarMetaCF & metaVar,                      
    MetadataCFVariable<TNumeric> const & meta)  
{
    metaVar.Set ( NcVarMetaCF::Meta_longName, meta.longName );
    metaVar.Set ( NcVarMetaCF::Meta_standardName, meta.standardName );
    metaVar.Set ( NcVarMetaCF::Meta_units, meta.units );
    metaVar.Set ( NcVarMetaCF::Meta_validMin, meta.validMin );
    metaVar.Set ( NcVarMetaCF::Meta_validMax, meta.validMax );
    metaVar.Set ( NcVarMetaCF::Meta_FillValue, meta.fillValue );
    metaVar.Set ( NcVarMetaCF::Meta_Encoding, meta.encoding );
}

template< typename TNumeric >
void operator>> (
    NcVarMetaCF & metaVar,                      
    MetadataCFVariable<TNumeric> & meta)        
{
    metaVar.Get ( NcVarMetaCF::Meta_longName, meta.longName );
    metaVar.Get ( NcVarMetaCF::Meta_standardName, meta.standardName );
    metaVar.Get ( NcVarMetaCF::Meta_units, meta.units );
    metaVar.Get ( NcVarMetaCF::Meta_validMin, meta.validMin );
    metaVar.Get ( NcVarMetaCF::Meta_validMax, meta.validMax );
    metaVar.Get ( NcVarMetaCF::Meta_FillValue, meta.fillValue );
    metaVar.Get ( NcVarMetaCF::Meta_Encoding, meta.encoding );
}

void operator<< (
    NcFileMetaCF & metaFile,                    
    MetadataCFGlobal const & meta);             

void operator>> (
    NcFileMetaCF & metaFile,                    
    MetadataCFGlobal & meta);                   

template< typename TNumeric >
std::ostream & operator<< (
    std::ostream & os,                          
    MetadataCFVariable<TNumeric> const & meta)  
{
    char const * const SPACE = "  ";
    char const * const EQUALS = " = ";
    char const NL = '\n';
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_longName) << EQUALS
       <<  meta.longName << NL;
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_standardName) << EQUALS
       << meta.standardName << NL;
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_units) << EQUALS
       << meta.units << NL;
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_validMin) << EQUALS
       << meta.validMin << NL;
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_validMax) << EQUALS
       << meta.validMax << NL;
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_FillValue) << EQUALS
       << meta.fillValue << NL;
    os << SPACE << NcVarMetaCF::GetAttName(NcVarMetaCF::Meta_Encoding) << EQUALS
       << meta.encoding << std::endl;
    return os;
}

std::ostream & operator<< (
    std::ostream & os,                          
    MetadataCFGlobal const & meta);             

void UpdateHistory (
    MetadataCFGlobal & meta,            
    std::string const & newHistory,     
    char const separator =              
        MetadataCFGlobal::defaultSeparator);


} // namespace netcdf

#endif // INC_netCDF_MetadataUtils_h