NcItem.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcItem_h
#define INC_netcdf_NcItem_h

#include <string>
#include "NcConfig.h"

namespace netcdf {


class NcItem
{
  public:

    enum { idGlobal = NC_GLOBAL };      
    static int const nullID = -999;

    virtual ~NcItem () = 0;

  protected:

    NcItem (
      bool const isNullObject = true)
      : nullObject (isNullObject),
        myID       (nullID),
        groupID    (nullID),
        fileID     (nullID)
      {
      }

    NcItem (
      int const useFileID,                              
      int const useID,                                  
      int const useGroupID = NcItem::idGlobal,          
      std::string const useName = std::string() )       
      : nullObject ( false ),
        myID       ( useID ),
        groupID    ( useGroupID == nullID ? NcItem::idGlobal : useGroupID ),
        fileID     ( useFileID ),
        myName     ( useName )
      {
      }

    NcItem ( NcItem const & rhs )
      {
        Copy (rhs);
      }

  public:

    bool IsNull() const { return nullObject; }
    std::string const & GetName() const { return myName; }
    int GetID()      const { return myID; }
    int GetGroupID() const { return groupID; }
    int GetFileID()  const { return fileID; }

    virtual void Rename ( std::string const & newName ) = 0;

    NcItem & operator= ( NcItem const & rhs )
      {
        Copy (rhs);
        return *this;
      }

    bool operator== ( NcItem const & rhs ) const
      {
        return myID == rhs.myID &&
                groupID == rhs.groupID &&
                fileID == rhs.fileID;
      }
    bool operator!= (NcItem const & rhs) const { return !operator==(rhs); }
    bool operator<  (NcItem const & rhs) const
      {
        if ( groupID == rhs.groupID )
            return myID < rhs.myID;
        else
            return myID < rhs.myID && groupID < rhs.groupID;
      }

  protected:

    bool nullObject;
    int myID;                   
    int groupID;                
    int fileID;                 
    std::string myName;         

    void Copy ( NcItem const & rhs )
      {
        nullObject = rhs.nullObject;
        myID       = rhs.myID;
        groupID    = rhs.groupID;
        fileID     = rhs.fileID;
        myName     = rhs.myName;
      }

};

inline NcItem::~NcItem () {}


} // namespace netcdf


#endif // INC_netcdf_NcItem_h