NcAtt.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcAtt_h
#define INC_netcdf_NcAtt_h

#include "NcType.h"
#include "NcItem.h"
#include "NcUtil.h"
#include "NcException.h"
#include <map>

namespace netcdf {

  class NcAtt : public NcItem
  {

  public:

    typedef std::multimap<std::string, NcType>          NcTypeMap;

    virtual ~NcAtt() {}

    NcAtt ();

    NcAtt (bool const isNullObject);

    NcAtt (
      int const useFileID,                      
      int const useID,                          
      std::string const attName,                
      int const useGroupID = nullID,            
      int const useVarID = NcItem::idGlobal);   

    NcAtt (NcAtt const & rhs);

    NcAtt (
      int const useID,          
      NcAtt const & rhs);       

    NcAtt& operator= (NcAtt const & rhs);

    int       Size() const;             
    NcType    GetType() const;
    NcGroup   GetParentGroup() const;
    int const GetVarID () const { return varID; }

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

    // get into vector
    void Get (TVecUbyte & data) const;                  
    void Get (TVecByte & data) const;                   
    void Get (TVecChar & data) const;                   
    void Get (TVecShort & data) const;                  
    void Get (TVecUshort & data) const;                 
    void Get (TVecInt & data) const;                    
    void Get (TVecUint & data) const;                   
    void Get (TVecFloat & data) const;                  
    void Get (TVecDouble & data) const;                 
    void Get (TVecInt64 & data) const;                  
    void Get (TVecUint64 & data) const;                 
    void Get (TVecString & data) const;                 

    // get 1 value
    void Get (unsigned char & data) const;              
    void Get (signed char & data) const;                
    void Get (char & data) const;                       
    void Get (short & data) const;                      
    void Get (unsigned short & data) const;             
    void Get (int & data) const;                        
    void Get (long & data) const;                       
    void Get (unsigned int & data) const;               
    void Get (unsigned long & data) const;              
    void Get (float & data) const;                      
    void Get (double & data) const;                     
    void Get (long long & data) const;                  
    void Get (unsigned long long & data) const;         

    // get into C array (caller allocates array)
    void Get (unsigned char* const data) const;         
    void Get (signed char* const data) const;           
    void Get (char* const data) const;                  
    void Get (short* const data) const;                 
    void Get (unsigned short* const data) const;        
    void Get (int* const data) const;                   
    void Get (long* const data) const;                  
    void Get (unsigned int* const data) const;          
    void Get (float* const data) const;                 
    void Get (double* const data) const;                
    void Get (long long* const data) const;             
    void Get (unsigned long long* const data) const;    
    void Get (char** const data) const;                 
    void Get (std::string& data) const;                 

    void Get (void* data) const;
    virtual void Rename( std::string const & newname );

  private:

    int mutable varID;

    inline void CheckType ( NcType::ncType const typeWanted ) const
    {
        if ( GetType().getTypeClass() != typeWanted )
            NcEXCEPTION( "attribute type != function type" );
    }

    inline void CheckLength ( int const maxLengthWanted ) const
    {
        if ( Size() > maxLengthWanted )
            NcEXCEPTION( "attribute data length > length of variable" );
    }

    // functions not allowed

  };


} // namespace netcdf

#endif // INC_netcdf_NcAtt_h