DataCollector.hpp

#ifndef DATACOLLECTOR_HPP
#define DATACOLLECTOR_HPP

#include <stdint.h>

#include "splash/CollectionType.hpp"
#include "splash/Dimensions.hpp"
#include "splash/Selection.hpp"
#include "splash/AttributeInfo.hpp"
#include "splash/core/DCDataSet.hpp"
#include "splash/core/splashMacros.hpp"

namespace splash
{

    class DataCollector
    {
    public:

        enum FileAccType
        {
            FAT_CREATE, FAT_READ, FAT_READ_MERGED, FAT_WRITE
        };

        typedef struct _FileCreationAttr
        {

            _FileCreationAttr() :
            fileAccType(FAT_CREATE),
            mpiSize(1, 1, 1),
            mpiPosition(0, 0, 0),
            enableCompression(false)
            {

            }

            FileAccType fileAccType;

            Dimensions mpiSize;

            Dimensions mpiPosition;

            bool enableCompression;
        } FileCreationAttr;

        typedef struct _DCEntry
        {
            std::string name;
            CollectionType* colType;
        } DCEntry;

        static void initFileCreationAttr(FileCreationAttr& attr)
        {
            attr.enableCompression = false;
            attr.fileAccType = FAT_CREATE;
            attr.mpiPosition.set(0, 0, 0);
            attr.mpiSize.set(1, 1, 1);
        }

        virtual ~DataCollector()
        {
        };

        virtual void open(
                const char *filename,
                FileCreationAttr& attr) = 0;

        virtual void close() = 0;

        virtual int32_t getMaxID() = 0;

        virtual void getMPISize(Dimensions& mpiSize) = 0;

        virtual void getEntryIDs(int32_t *ids, size_t *count) = 0;

        virtual void getEntriesForID(int32_t id, DCEntry *entries, size_t *count) = 0;

        virtual void write(int32_t id,
                const CollectionType& type,
                uint32_t ndims,
                const Selection select,
                const char* name,
                const void* buf) = 0;

        virtual void append(int32_t id,
                const CollectionType& type,
                size_t count,
                const char *name,
                const void *buf) = 0;

        virtual void append(int32_t id,
                const CollectionType& type,
                size_t count,
                size_t offset,
                size_t stride,
                const char *name,
                const void *buf) = 0;

        virtual void remove(int32_t id) = 0;

        virtual void remove(int32_t id,
                const char *name) = 0;

        virtual void createReference(int32_t srcID,
                const char *srcName,
                int32_t dstID,
                const char *dstName) = 0;

        virtual void createReference(int32_t srcID,
                const char *srcName,
                int32_t dstID,
                const char *dstName,
                Dimensions count,
                Dimensions offset,
                Dimensions stride) = 0;

        virtual AttributeInfo readGlobalAttributeInfo(
                int32_t id,
                const char *name,
                Dimensions *mpiPosition = NULL) = 0;

        SPLASH_DEPRECATED("Use safer readGlobalAttributeInfo")
        virtual void readGlobalAttribute(
                const char *name,
                void* buf,
                Dimensions *mpiPosition = NULL) = 0;

        virtual void writeGlobalAttribute(const CollectionType& type,
                const char *name,
                const void* buf) = 0;

        virtual void writeGlobalAttribute(const CollectionType& type,
                const char *name,
                uint32_t ndims,
                const Dimensions dims,
                const void* buf) = 0;

        virtual AttributeInfo readAttributeInfo(int32_t id,
                const char *dataName,
                const char *attrName,
                Dimensions *mpiPosition = NULL) = 0;

        SPLASH_DEPRECATED("Use safer readAttributeInfo")
        virtual void readAttribute(int32_t id,
                const char *dataName,
                const char *attrName,
                void *buf,
                Dimensions *mpiPosition = NULL) = 0;

        virtual void writeAttribute(int32_t id,
                const CollectionType& type,
                const char *dataName,
                const char *attrName,
                const void *buf) = 0;

        virtual void writeAttribute(int32_t id,
                const CollectionType& type,
                const char *dataName,
                const char *attrName,
                uint32_t ndims,
                const Dimensions dims,
                const void *buf) = 0;

        virtual void read(int32_t id,
                const char* name,
                Dimensions &sizeRead,
                void* buf) = 0;

        virtual void read(int32_t id,
                const char* name,
                const Dimensions dstBuffer,
                const Dimensions dstOffset,
                Dimensions &sizeRead,
                void* buf) = 0;

        virtual CollectionType* readMeta(int32_t id,
                const char* name,
                const Dimensions dstBuffer,
                const Dimensions dstOffset,
                Dimensions &sizeRead) = 0;
    };

}

#endif /* DATACOLLECTOR_HPP */