NcString.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcString_h
#define INC_netcdf_NcString_h

#include "NcType.h"
#include "NcTypeV4.h"

namespace netcdf {

  class NcString
    : public NcType,
      public NcTypeV4
  {
    public:
        typedef std::string             value_type;
        typedef std::vector<value_type> vector_type;

        NcString();

        static value_type FillValue ()  { return std::string(fillValue); }
        static value_type MinValue ()   { return std::string(); }       // dummy
        static value_type MaxValue ()   { return std::string(); }       // dummy
        static std::size_t SizeOf ()    { return sizeof(value_type::value_type); }

        void Get (                              
          int const groupID,                    
          int const varID,                      
          vector_type & data );                 

        void Get (                              
          int const groupID,                    
          int const varID,                      
          TVecIndex const & indices,            
          value_type & data);                   

        void Get (                              
          int const groupID,                    
          int const varID,                      
          TVecIndex const & start,              
          TVecIndex const & count,              
          vector_type & data);                  

//      void Get (                              ///< read a subsampled (strided) section
//        int const groupID,                    ///< group ID
//        int const varID,                      ///< variable ID
//        TVecIndex const & start,              ///< zero-based index to start reading
//        TVecIndex const & count,              ///< count along each dimension (>= 1)
//        TVecStride const & stride,            ///< interval along each dimension
//        vector_type & data);                  ///< vector to receive data values

//      void Get (                              ///< read a mapped array section
//        int const groupID,                    ///< group ID
//        int const varID,                      ///< variable ID
//        TVecIndex const & start,              ///< zero-based index to start reading
//        TVecIndex const & count,              ///< count along each dimension (>= 1)
//        TVecStride const & stride,            ///< interval along each dimension
//        TVecStride const & imap,              ///< mapping intervals for each dimension (see NetCDF doc)
//        vector_type & data);                  ///< vector to receive data values

        void Put (                              
          int const groupID,                    
          int const varID,                      
          vector_type const & data );           

//      void Put (                              ///< write an array of values
//        int const groupID,                    ///< group ID
//        int const varID,                      ///< variable ID
//        TVecIndex const & indices,            ///< indices at which to write
//        value_type const & data);             ///< value to write

        void Put (                              
          int const groupID,                    
          int const varID,                      
          TVecIndex const & start,              
          TVecIndex const & count,              
          vector_type const & data);            

//      void Put (                              ///< write a subsampled (strided) section
//        int const groupID,                    ///< group ID
//        int const varID,                      ///< variable ID
//        TVecIndex const & start,              ///< zero-based index to start write
//        TVecIndex const & count,              ///< count along each dimension (>= 1)
//        TVecStride const & stride,            ///< interval along each dimension
//        vector_type const & data);            ///< vector of values to write

//      void Put (                              ///< write a mapped array section
//        int const groupID,                    ///< group ID
//        int const varID,                      ///< variable ID
//        TVecIndex const & start,              ///< zero-based index to start reading
//        TVecIndex const & count,              ///< count along each dimension (>= 1)
//        TVecStride const & stride,            ///< interval along each dimension
//        TVecStride const & imap,              ///< mapping intervals for each dimension (see NetCDF doc)
//        vector_type const & data);            ///< vector of values to write

    private:

        static char const * const myTypeName;
        static char const * const fillValue;

  };

  extern NcString ncString;

} // namespace netcdf
#endif