---

DataArchive.h

Go to the documentation of this file.

/* SimData: Data Infrastructure for Simulations
 * Copyright (C) 2002, 2003 Mark Rose <tm2@stm.lbl.gov>
 * 
 * This file is part of SimData.
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program 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 for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef __SIMDATA_DATAARCHIVE_H__
#define __SIMDATA_DATAARCHIVE_H__

#include <SimData/Export.h>
#include <SimData/Uniform.h>
#include <SimData/Link.h>
#include <SimData/Exception.h>
#include <SimData/HashUtility.h>
#include <SimData/Namespace.h>

#include <string>
#include <cstdio>
#include <cstdlib>


NAMESPACE_SIMDATA


SIMDATA_EXCEPTION(BadMagic)


SIMDATA_EXCEPTION(BadByteOrder)


SIMDATA_EXCEPTION(CorruptArchive)


SIMDATA_EXCEPTION(IndexError)


SIMDATA_EXCEPTION(ObjectMismatch)


SIMDATA_EXCEPTION(IOError)


SIMDATA_EXCEPTION(MissingInterface);


class DataManager;
class Object;
class InterfaceProxy;


//For SWIG (not currently used):
//struct FP { FILE* f; std::string name; std::string mode; };


class SIMDATA_EXPORT DataArchive {

        friend class LinkBase;
        friend class DataManager;

private:

        typedef std::vector<char> Buffer;

        struct TableEntry {
                ObjectID pathhash;
                ObjectID classhash;
                uint32 offset;
                uint32 length;
        };

        static DataArchive* defaultArchive;

        enum {
                AS = 1024,
                BUFFERSIZE = 4096,
                BUFFERS = 10
        };

        std::vector<TableEntry> _table;

        std::vector<Buffer> _buffers;
        unsigned int _buffer;

        
        typedef HASH_MAPS<ObjectID, std::vector<ObjectID>, ObjectID_hash, ObjectID_eq>::Type ChildMap;
        ChildMap _children;

        typedef HASH_MAPS<ObjectID, std::string, ObjectID_hash, ObjectID_eq>::Type PathMap;
        PathMap _pathmap;

        typedef HASH_MAPS<ObjectID, std::size_t, ObjectID_hash, ObjectID_eq>::Type TableMap;
        TableMap _table_map;

        typedef HASH_MAPS<ObjectID, LinkBase, ObjectID_hash, ObjectID_eq>::Type CacheMap;
        CacheMap _static_map;

        std::vector<std::string> _paths;
        
        FILE *_f;
        bool _is_read;
        uint32 _table_offset;
        bool _finalized;
        std::string _fn;
        bool _chain;
        DataManager *_manager;

        void writeMagic();

        void readMagic();

        void readTable();

        void writeTable();

        void _readPaths();

        void _writePaths() const;

public:

        DataArchive(std::string const &fn, bool read, bool chain=true);

        ~DataArchive();

        void addObject(Object &object, std::string const & path);

        void finalize();

        bool isFinalized();

        bool isWrite();

        void setDefault();

        static DataArchive* getDefault();

        const LinkBase getObject(std::string const &path_str);

        const LinkBase getObject(const Path& path, std::string const &path_str="");

        std::string getFileName() const { return _fn; }

        std::vector<ObjectID> getChildren(ObjectID const &id) const;
        
        std::vector<ObjectID> getChildren(std::string const & path) const;

        bool hasObject(ObjectID const &id) const;

        bool hasObject(std::string const & path) const;

        std::string getPathString(ObjectID const &id) const; 

        std::vector<ObjectID> getAllObjects() const;

        std::vector<std::string> getAllPathStrings() const;

        void cleanStatic();

        InterfaceProxy *getObjectInterface(ObjectID const &id, std::string const &path="") const;

        InterfaceProxy *getObjectInterface(std::string const &path) const;


        void dump() const;

        // protected methods made public for Python access, don't use!
        /*
        long _getOffset(); 
        FP _filePointer();
        */

protected:
        void _addEntry(int offset, int length, ObjectID hash, std::string const &path);
        
        /*
        Object* getObject(const Object &a, const char* path);
        Object* getObject(const Object &a, ObjectID path, const char* path="");
        Object* getObject(ObjectID path);
        */

        void _addStatic(Object* ptr, std::string const &path_str, ObjectID key=0);

        LinkBase const * _getStatic(ObjectID key);

        Object* _createObject(ObjectID classhash);

        const TableEntry* _lookupPath(Path const& path, std::string const &path_str="") const;

        const TableEntry* _lookupPath(ObjectID const &id, std::string const &path_str="") const;

        DataManager *getManager() const { return _manager; }

private:
        void setManager(DataManager *m);
        ChildMap const &getChildMap() const { return _children; }
};




NAMESPACE_SIMDATA_END

#endif //__SIMDATA_DATAARCHIVE_H__

---

SimData version pre-0.4.0. For more information on SimData, visit the SimData Homepage. Generated on Tue Oct 14 12:06:38 2003, using Doxygen 1.2.18.