AttributeInfo.hpp

/*
 * Copyright 2016 Alexander Grund
 *
 * This file is part of libSplash.
 *
 * libSplash is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * libSplash is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with libSplash.
 * If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef DCATTRIBUTE_INFO_H
#define DCATTRIBUTE_INFO_H

#include "splash/Dimensions.hpp"
#include "splash/DCException.hpp"
#include "splash/core/H5IdWrapper.hpp"
#include "splash/core/splashMacros.hpp"
#include <string>

namespace splash
{
    class CollectionType;

    class AttributeInfo
    {
        H5AttributeIdRefCt attr_;

   public:
        explicit AttributeInfo(hid_t attr);
        explicit AttributeInfo(H5AttributeId& attr);
        ~AttributeInfo();

        AttributeInfo(const AttributeInfo& other);
        AttributeInfo& operator=(const AttributeInfo& other);

        size_t getMemSize() throw(DCException);
        const CollectionType& getType() throw(DCException);
        Dimensions getDims() throw(DCException);
        uint32_t getNDims() throw(DCException);
        bool isScalar()  throw(DCException){ return getNDims() == 1 && getDims().getScalarSize() == 1; }
        bool isVarSize() throw(DCException);
        std::string readName();

        void read(const CollectionType& colType, void* buf) throw(DCException);

        bool readNoThrow(const CollectionType& colType, void* buf);

        void read(void* buf, size_t bufSize) throw(DCException);
        
        void close();

        friend void swap(AttributeInfo& lhs, AttributeInfo& rhs);

    private:

        std::string getExceptionString(const std::string& msg);
        void loadType() throw(DCException);
        void loadSpace() throw(DCException);
        
        // Those values are lazy loaded on access
        CollectionType* colType_;
        H5TypeId type_;
        H5DataspaceId space_;
        uint32_t nDims_;
};
}

#endif /* DCATTRIBUTE_INFO_H */