BackingStore.h

Go to the documentation of this file.

/*
 * opencog/atomspace/BackingStore.h
 *
 * Implements an interface class for storage providers.
 *
 * Copyright (C) 2009, 2013 Linas Vepstas <linasvepstas@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * 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 Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_BACKING_STORE_H
#define _OPENCOG_BACKING_STORE_H

#include <set>

#include <opencog/atomspace/Atom.h>
#include <opencog/atomspace/Link.h>
#include <opencog/atomspace/Node.h>

namespace opencog
{
class BackingStore
{
    public:
        virtual ~BackingStore() {}

        virtual LinkPtr getLink(Type, const HandleSeq&) const = 0;

        virtual NodePtr getNode(Type, const char *) const = 0;

        virtual AtomPtr getAtom(Handle) const = 0;

        virtual HandleSeq getIncomingSet(Handle) const = 0;

        virtual void storeAtom(Handle) = 0;

        virtual void loadType(AtomTable&, Type) = 0;

        virtual void barrier() = 0;

        virtual bool ignoreType(Type t) const {
             return (_ignored_types.end() != _ignored_types.find(t));
        }

        virtual bool ignoreAtom(Handle) const;

        std::set<Type> _ignored_types;
};

} //namespace opencog

#endif // _OPENCOG_BACKING_STORE_H