NcType.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcType_h
#define INC_netcdf_NcType_h

#include "NcConfig.h"
#include "NcException.h"
#include "stddef.h"
#include <string>
#include <vector>

namespace netcdf {


  class NcGroup;

  // some useful global types
  typedef std::vector< signed char >            TVecByte;
  typedef std::vector< unsigned char >          TVecUbyte;
  typedef std::vector< char >                   TVecChar;
  typedef std::vector< short >                  TVecShort;
  typedef std::vector< unsigned short >         TVecUshort;
  typedef std::vector< int >                    TVecInt;
  typedef std::vector< unsigned int >           TVecUint;
  typedef std::vector< float >                  TVecFloat;
  typedef std::vector< double >                 TVecDouble;
  typedef std::vector< long long >              TVecInt64;
  typedef std::vector< unsigned long long >     TVecUint64;
  typedef std::vector< std::string >            TVecString;
  typedef std::vector< std::size_t >            TVecIndex;
  typedef std::vector< ptrdiff_t >              TVecStride;


  class NcType
  {

  public:

    enum ncType
    {
      nc_NAT      = NC_NAT,             
      nc_BYTE     = NC_BYTE,            
      nc_CHAR     = NC_CHAR,            
      nc_SHORT    = NC_SHORT,           
      nc_INT      = NC_INT,             
      nc_FLOAT    = NC_FLOAT,           
      nc_DOUBLE   = NC_DOUBLE,          
      nc_UBYTE    = NC_UBYTE,           
      nc_USHORT   = NC_USHORT,          
      nc_UINT     = NC_UINT,            
      nc_INT64    = NC_INT64,           
      nc_UINT64   = NC_UINT64,          
      nc_STRING   = NC_STRING,          
      nc_VLEN     = NC_VLEN,            
      nc_OPAQUE   = NC_OPAQUE,          
      nc_ENUM     = NC_ENUM,            
      nc_COMPOUND = NC_COMPOUND,        
      nc_Unknown                        // last one always!
    };

    NcType ();

    NcType (
      std::string const myClassName,    
      ncType const id);                 

    NcType (NcType const & rhs);

    virtual ~NcType() {}

    NcType& operator=  (NcType const & rhs);
    bool    operator== (NcType const & rhs) const;
    bool    operator!= (NcType const & rhs) const { return !operator== (rhs); }
    bool    operator<  (NcType const & rhs) const;

    ncType  GetID()          const { return myID; }

    virtual std::string GetName() const;

    virtual size_t Size() const;

    virtual ncType getTypeClass() const;        
    virtual ncType GetTypeClass() const;

    std::string const & getTypeClassName () const { return myName; }    
    std::string const & GetTypeClassName () const { return myName; }

    bool IsNull() const { return nullObject; }

  protected:

    static ncType const nullID = nc_NAT;

    bool nullObject;
    std::string myName;         
    ncType myID;                


    void ErrorDimsAreZero (std::string const & className);
    void ErrorArrayNcSizeMismatch (std::string const & className);

  };



class NcNullType : public NcType
{
  public:

    NcNullType ()
      : NcType ()
      {
      }

};

extern NcNullType nullType;



} // namespace netcdf

#endif // INC_netcdf_NcType_h