NcGroup.h

Go to the documentation of this file.

#ifndef INC_netcdf_NcGroup_h
#define INC_netcdf_NcGroup_h

#include "NcItem.h"
#include "NcType.h"
#include "NcEnumType.h"
#include "NcGroupAtt.h"
#include <vector>
#include <set>
#include <map>

namespace netcdf {

  class NcVar;
  class NcDim;
  class NcVlenType;
  class NcCompoundType;
  class NcOpaqueType;


class NcGroup : public NcItem
{

  public:

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

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

    typedef std::map<std::string, NcGroup>              NcGroupMapUnique;
    typedef std::multimap<std::string, NcGroup>         NcGroupMap;
    typedef std::pair<std::string, NcGroup>             NcGroupPair;
    typedef std::set<NcGroup>                           NcGroupSet;
    typedef std::multimap<std::string, NcType>          NcTypeMap;
    typedef std::pair<std::string, NcType>              NcTypePair;
    typedef std::set<NcType>                            NcTypeSet;
    typedef std::multimap<std::string, NcTypeUserDef>   NcUserTypeMap;
    typedef std::multimap<std::string, NcVar>           NcVarMap;
    typedef std::pair<std::string, NcVar>               NcVarPair;
    typedef std::set<NcVar>                             NcVarSet;
    typedef std::multimap<std::string, NcDim>           NcDimMap;
    typedef std::pair<std::string, NcDim>               NcDimPair;
    typedef std::set<NcDim>                             NcDimSet;
    typedef std::multimap<std::string, NcGroupAtt>      NcGroupAttMap;
    typedef std::pair<std::string, NcGroupAtt>          NcGroupAttPair;
    typedef std::set<NcGroupAtt>                        NcGroupAttSet;


    NcGroup();                          

    NcGroup(                            
      int const useFileID,              
      int const groupId,                
      std::string const groupName);     

    NcGroup(NcGroup const & rhs);

    virtual ~NcGroup();

    // NcGroup & operator= (NcGroup const & rhs);       // not implemented
    bool operator< ( NcGroup const & rhs) const;

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

    NcGroup GetParentGroup() const;

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

    NcGroupMap GetGroups (
        NcGroup::GroupLocation location = ChildrenGrps ) const;

    NcGroupSet GetGroups (
        std::string const name,
        NcGroup::GroupLocation location=ChildrenGrps) const;

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

    NcGroup AddGroup (std::string const name) const;

    bool IsRootGroup () const;

    //-----------------------------------------------------------------------
    //    variables
    //-----------------------------------------------------------------------

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

    bool HaveVariable (
      std::string const name,
      NcGroup::Location const location = Current) const;

   NcVarMap GetVars (NcGroup::Location location=Current) const;

    NcVarSet GetVars (
        std::string const name,
        NcGroup::Location location=Current) const;

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

    NcVar AddVar(std::string const name, std::string const typeName) const;

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

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

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

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

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

    NcVar AddVar (NcVar const & var);

    //-----------------------------------------------------------------------
    //    attributes
    //-----------------------------------------------------------------------

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

    bool HaveAttribute (
      std::string const name,
      NcGroup::Location const location = Current) const;

  private:

    bool HaveAttribute (                // helper function for public HaveAttribute
      std::string const & name,         // name to search for
      int const ncid,                   // group ID to search in
      size_t & attLength) const;        // attribute length

  public:

    NcGroupAttMap GetAttributes (NcGroup::Location location = Current) const;

    NcGroupAttSet GetAttributes (
        std::string const name,
        NcGroup::Location location=Current) const;

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

    // NcUbyte
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const unsigned char* dataValues ) const;

    // NcByte
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const signed char* dataValues ) const;

    // NcChar
    NcGroupAtt PutAtt ( std::string const name, char const aChar ) const;

    // NcShort
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, short datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const short* dataValues ) const;

    // NcUshort
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, unsigned short datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const unsigned short* dataValues ) const;

    // NcInt as int
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, int datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const int* dataValues ) const;

    // NcInt as long
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, long datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const long* dataValues ) const;

    // NcUint as int
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, unsigned int datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const unsigned int* dataValues ) const;

    // NcUint as long

    // NcFloat
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, float datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const float* dataValues ) const;

    // NcDouble
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, double datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const double* dataValues ) const;

    // NcInt64
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, long long datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const long long* dataValues ) const;

    // NcUint64
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, unsigned long long datumValue ) const;
    NcGroupAtt PutAtt ( std::string const name, NcType const & type, size_t len, const unsigned long long* dataValues ) const;

    // NcString
    NcGroupAtt PutAtt ( std::string const name, size_t len, const char** dataValues ) const;
    NcGroupAtt PutAtt ( std::string const name, std::string const & dataValues ) const;
    NcGroupAtt PutAtt (std::string const name, std::vector< std::string > const & strVec );

    NcGroupAtt PutAtt (std::string const name, NcType const & type, size_t len, const void* dataValues) const;


    /*
    template< class TAttValue >
    NcGroupAtt PutAtt ( std::string const name, std::vector<TAttValue> data )
      {
        return PutAtt( name, )
      }
    */

    NcGroupAtt PutAtt ( NcGroupAtt const & att );

    //-----------------------------------------------------------------------
    //    dimensions
    //-----------------------------------------------------------------------

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

    NcDimMap GetDims (NcGroup::Location const location=Current) const;

    NcDimSet GetDims (std::string const name, NcGroup::Location const location=Current) const;

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

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

    NcDim AddDim (std::string const name) const;

    NcDim AddDim (NcDim const & dim) const;

    //-----------------------------------------------------------------------
    //    types
    //-----------------------------------------------------------------------

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

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

    NcTypeMap GetTypes (
        NcGroup::Location location=Current) const;

    NcTypeSet GetTypes (
        std::string const & name,
        NcGroup::Location location=Current) const;

    NcTypeSet GetTypes (
        NcType::ncType enumType,
        NcGroup::Location location=Current) const;

    NcTypeSet GetTypes (
        std::string const & name,
        NcType::ncType enumType,
        NcGroup::Location location=Current) const;

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

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

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


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

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

    NcGroupMapUnique GetCoordVars (Location location=Current) const;

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


  protected:

    virtual void Rename (std::string const &) {}        // no-op


};  // class NcGroup


inline NcGroup::~NcGroup() {}



} // namespace netcdf

#endif