ColTypeString.hpp

#ifndef COLTYPESTRING_H
#define COLTYPESTRING_H

#include "splash/CollectionType.hpp"

#include <string>

namespace splash
{
    class ColTypeString : public CollectionType
    {
    public:

        ColTypeString()
        {
            this->type = H5Tcopy(H5T_C_S1);
            H5Tset_size(this->type, H5T_VARIABLE);
        }

        ColTypeString(size_t len)
        {
            this->type = H5Tcopy(H5T_C_S1);
            /* HDF5 requires space for the \0-terminator character,
             * otherwise it will not be stored or retrieved */
            H5Tset_size(this->type, len + 1);
        }

        ~ColTypeString()
        {
            H5Tclose(this->type);
        }

        size_t getSize() const
        {
            size_t myElements = H5Tget_size(this->type);

            /* for variable length string the size is first known after reading
             * the actual data or attribute, so we forward HDF5's behavior */
            if(isVariableLength())
               return myElements; /* == sizeof(char*) see H5Tget_size description */
            else if( isNullTerminated() )
               return sizeof(char) * (myElements - 1); /* just as strlen() */
            else
                return sizeof(char) * myElements;
        }

        static CollectionType* genType(hid_t datatype_id)
        {
            H5T_class_t h5_class = H5Tget_class(datatype_id);

            if(h5_class == H5T_STRING)
            {
                return new ColTypeString(datatype_id, true);
            } else
            {
                return NULL;
            }
        }

        std::string toString() const
        {
            if(isVariableLength())
                return "VLString";
            else
                return "String";
        }

        bool isVariableLength() const
        {
            return H5Tis_variable_str(this->type);
        }

        bool isNullTerminated() const
        {
            return H5Tget_strpad(type) == H5T_STR_NULLTERM;
        }

    private:
        explicit ColTypeString(H5DataType inType, bool /*dummy*/):
        CollectionType(H5Tcopy(inType))
        {
        }
    };

}

#endif /* COLTYPESTRING_H */