NcFile.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcFile_h
#define INC_netcdf_NcFile_h

#include "NcConfig.h"
#include "NcGroup.h"
#include "NcVersion.h"

namespace netcdf {

class NcFile : public NcGroup
{
  public:

    enum FileMode
    {
        ReadOnly,               
        Write,                  
        Replace,                
        New                     
    };

    enum FileFormat
    {
        Classic,                
        Offset64Bits,           
        NetCDF4,                
        NetCDF4Classic          
    };

#ifdef USE_PARALLEL

    NcFile (
        MPI::Comm & mpiComm,                            
        MPI::Info & mpiInfo,                            
        std::string const fileName,                     
        FileMode const fileMode,                        
        size_t const * const bufrsizeptr = NULL,        
        size_t const initialsize         = 0);          

    NcFile (
        std::string const fileName,                     
        FileMode const fileMode,                        
        FileFormat const fileFormat      = NetCDF4,     
        size_t const * const bufrsizeptr = NULL,        
        size_t const initialsize         = 0);          

    NcFile (
        std::string const fileName,                     
        FileMode const fileMode = ReadOnly);            

    bool IsParallel () const { return mpi.IsInitialized(); }

    // no check if initialized
    MPI::Comm & Comm () { return mpi.Comm(); }
    MPI::Info & Info () { return mpi.Info(); }

#else

    NcFile (
        std::string const fileName,             
        FileMode const fileMode = ReadOnly);    

    NcFile (
        std::string const fileName,                     
        FileMode const fileMode,                        
        FileFormat const fileFormat,                    
        size_t const * const bufrsizeptr = NULL,        
        size_t const initialsize         = 0);          

    bool IsParallel () const { return false; }

#endif

    FileFormat GetFormat ();                    
    bool IsNetCDF3 ();                          

    std::string GetFileName () const;           
    FileMode GetFileMode () const { return ncFileMode; }
    void Sync();                                

    void ToDefineMode ();                       
    void ToDataMode ();                         

    void Close ();

    virtual ~NcFile(); //closes file and releases all resources


  private:

    friend class NcGroup;

    static char const * const rootGroupName;

    std::string const netcdfFileName;
    FileMode ncFileMode;

    #ifdef USE_PARALLEL
      NcMPI mpi;
    #endif

    int GetOpenMode (
        FileMode const fileMode,
        FileFormat const fileFormat );

    void CheckAccess ();        // throws if invalid access

    void ThrowOpenOrCreateError (
        std::string const & what,       
        std::string const & fileName,
        FileMode const fileMode,
        FileFormat const fileFormat);

    // members not allowed
    NcFile(const NcFile& rhs);
    NcFile & operator= (const NcFile& rhs);

}; // class NcFile


inline bool NcFile::IsNetCDF3 ()
{
    FileFormat const fileFormat = GetFormat();
    return ( fileFormat == Classic || fileFormat == Offset64Bits );
}

//------------------------------------------------------------------------------
//      Helper functions for NcFile
//------------------------------------------------------------------------------

std::string const & GetFileModeStr (NcFile::FileMode const fileMode);

std::string const & GetFileFormatStr (NcFile::FileFormat const fileFormat);


} // namespace netcdf

#endif // INC_netcdf_NcFile_h