ncGroup.h

#include <string>
#include <vector>
#include <set>
#include <map>
#include "ncType.h"
#include "ncEnumType.h"
#include "ncGroupAtt.h"



#ifndef NcGroupClass
#define NcGroupClass


namespace netCDF
{

  static int file_id;

  class NcVar;          // forward declaration.
  class NcDim;          // forward declaration.
  class NcVlenType;     // forward declaration.
  class NcCompoundType; // forward declaration.
  class NcOpaqueType;   // forward declaration.

  class NcGroup
  {

  public:

    enum GroupLocation
      {
    ChildrenGrps,              
    ParentsGrps,               
    ChildrenOfChildrenGrps,    
    AllChildrenGrps,           
    ParentsAndCurrentGrps,     
    AllGrps                    
      };

    enum Location
      {
    Current,            
    Parents,            
    Children,           
    ParentsAndCurrent,  
    ChildrenAndCurrent, 
    All                 
      };


    NcGroup& operator=(const NcGroup& rhs);

    NcGroup();

    //* constructor */
    NcGroup(int groupId);

    NcGroup(const NcGroup& rhs);

    virtual ~NcGroup();

    bool operator==(const NcGroup& rhs) const;

    bool operator!=(const NcGroup& rhs) const;

    friend bool operator<(const NcGroup& lhs,const NcGroup& rhs);

    friend bool operator>(const NcGroup& lhs,const NcGroup& rhs);

    // /////////////
    // NcGroup-related methods
    // /////////////

    std::string getName(bool fullName=false) const;

    NcGroup getParentGroup() const ;

    int  getId() const;

    int getGroupCount(NcGroup::GroupLocation location=ChildrenGrps) const;

    std::multimap<std::string,NcGroup> getGroups(NcGroup::GroupLocation location=ChildrenGrps) const;


    std::set<NcGroup> getGroups(const std::string& name,NcGroup::GroupLocation location=ChildrenGrps) const;

    NcGroup getGroup(const std::string& name,NcGroup::GroupLocation location=ChildrenGrps) const;

    NcGroup addGroup(const std::string& name) const;


    bool isNull() const  {return nullObject;}

    bool isRootGroup() const;

    // /////////////
    // NcVar-related accessors
    // /////////////

    int getVarCount(NcGroup::Location location=Current) const;

   std::multimap<std::string,NcVar> getVars(NcGroup::Location location=Current) const;

    std::set<NcVar> getVars(const std::string& name,NcGroup::Location location=Current) const;

    NcVar getVar(const std::string& name,NcGroup::Location location=Current) const;

    NcVar addVar(const std::string& name, const NcType& ncType) const;

    NcVar addVar(const std::string& name, const std::string& typeName, const std::string& dimName) const;

    NcVar addVar(const std::string& name, const NcType& ncType, const NcDim& ncDim) const;

    NcVar addVar(const std::string& name, const std::string& typeName, const std::vector<std::string>& dimNames) const;


    NcVar addVar(const std::string& name, const NcType& ncType, const std::vector<NcDim>& ncDimVector) const;

    // /////////////
    // NcGroupAtt-related methods
    // /////////////

    int getAttCount(NcGroup::Location location=Current) const;

    std::multimap<std::string,NcGroupAtt> getAtts(NcGroup::Location location=Current) const;

    std::set<NcGroupAtt> getAtts(const std::string& name,NcGroup::Location location=Current) const;

    NcGroupAtt getAtt(const std::string& name,NcGroup::Location location=Current) const;


    NcGroupAtt putAtt(const std::string& name, size_t len, const char** dataValues) const ;

    NcGroupAtt putAtt(const std::string& name, const std::string& dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, short datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, int datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, long datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, float datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, double datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, unsigned short datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, unsigned int datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, unsigned long long datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, long long datumValue) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const unsigned char* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const signed char* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const short* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const int* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const long* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const float* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const double* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const unsigned short* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const unsigned int* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const unsigned long long* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const long long* dataValues) const ;
    NcGroupAtt putAtt(const std::string& name, const NcType& type, size_t len, const void* dataValues) const ;



    // /////////////
    // NcDim-related methods
    // /////////////

    int getDimCount(NcGroup::Location location=Current) const;

    std::multimap<std::string,NcDim> getDims(NcGroup::Location location=Current) const;

    std::set<NcDim> getDims(const std::string& name,NcGroup::Location location=Current) const;

    NcDim getDim(const std::string& name,NcGroup::Location location=Current) const;

    NcDim addDim(const std::string& name, size_t dimSize) const;

    NcDim addDim(const std::string& name) const;

    // /////////////
    // NcType-related methods
    // /////////////

    int getTypeCount(NcGroup::Location location=Current) const;


    int getTypeCount(NcType::ncType enumType, NcGroup::Location location=Current) const;


    std::multimap<std::string,NcType> getTypes(NcGroup::Location location=Current) const;


    std::set<NcType> getTypes(const std::string& name, NcGroup::Location location=Current) const;

    std::set<NcType> getTypes(NcType::ncType enumType, NcGroup::Location location=Current) const;


    std::set<NcType> getTypes(const std::string& name, NcType::ncType enumType, NcGroup::Location location=Current) const;


    NcType getType(const std::string& name, NcGroup::Location location=Current) const;


    NcEnumType addEnumType(const std::string& name,NcEnumType::ncEnumType basetype) const;


    NcVlenType addVlenType(const std::string& name,NcType& basetype) const;


    NcOpaqueType addOpaqueType(const std::string& name, size_t size) const;


    NcCompoundType addCompoundType(const std::string& name, size_t size) const;


    std::map<std::string,NcGroup> getCoordVars(NcGroup::Location location=Current) const;

    void getCoordVar(std::string& coordVarName, NcDim& ncDim, NcVar& ncVar, NcGroup::Location location=Current) const;


  protected:

    /* NcGroup& operator=(const NcGroup& rhs); */

    bool nullObject;

    int myId;

  };

}
#endif