NcFileMetaCF.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcFileMetaCF_h
#define INC_netcdf_NcFileMetaCF_h

#include "NcFile.h"
#include <memory>
#include "stringutil.h"


namespace netcdf {


class NcFileMetaCF
{
  public:

    #ifndef USE_PARALLEL
      NcFileMetaCF ( std::string const ncFileName );
    #endif
    // if parallel netCDF, must open the file elsewhere.
    NcFileMetaCF ( netcdf::NcFile & useNcFile );

    enum MetaItem               // items match elements of array attNames
    {
        Meta_title,             
        Meta_institution,       
        Meta_contact,           
        Meta_copyright,         
        Meta_conventions,       
        Meta_references,        
        Meta_source,            
        Meta_comment,           
        Meta_history,           
        Meta_Unknown            // last item always
    };

    void Set (
        MetaItem const which,
        std::string const & data);

    void Append (
        MetaItem const which,
        std::string const & data);

    void Get (
        MetaItem const which,
        std::string & data) const;

    void Get (
        MetaItem const which,
        TStringArray & data) const;

    static char const * const GetAttName (MetaItem const which)
      { return attNames[which]; /* no checks */ }

    bool Exists (MetaItem const which) const;

  private:

    static char const * const attNames[];
    std::auto_ptr< netcdf::NcFile > pNcFile;
    netcdf::NcFile & nc;

    template< class T /* string or TStringArray */ >
    void Read (
        MetaItem const which,
        T & data ) const
    {
        if ( which != Meta_Unknown )
            nc.GetAtt( attNames[which] ).Get( data );
    }

    template< class T /* string or TStringArray */ >
    void Write (
        MetaItem const which,
        T const & data )
    {
        if ( which != Meta_Unknown )
            nc.PutAtt( std::string( attNames[which] ), data );
    }

    // not used
    NcFileMetaCF ( NcFileMetaCF const & rhs );
    NcFileMetaCF & operator= ( NcFileMetaCF const & rhs );

};


inline bool NcFileMetaCF::Exists (MetaItem const which) const
{
    return nc.HaveAttribute( GetAttName(which) );
}




} // namespace netcdf

#endif // INC_netcdf_NcFileMetaCF_h