dictionary.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef dictionr_h
#define dictionr_h

#include "oofemcfg.h"
#include "pair.h"
#include "error.h"
#include "contextioresulttype.h"
#include "contextmode.h"

#include <string>
#include <iosfwd>

namespace oofem {
class DataStream;

class OOFEM_EXPORT Dictionary
{
protected:
    Pair *first;
    Pair *last;

public:
    Dictionary() : first(NULL), last(NULL) { }
    ~Dictionary();

    void clear();
    Pair *add(int aKey, double value);
    double &at(int aKey);
    bool includes(int aKey);
    void printYourself();
    void formatAsString(std :: string &str);
    int giveSize();

    contextIOResultType saveContext(DataStream &stream, ContextMode mode, void *obj = NULL);
    contextIOResultType restoreContext(DataStream &stream, ContextMode mode, void *obj = NULL);

    friend std :: ostream &operator << ( std :: ostream & out, const Dictionary & r );
};
} // end namespace oofem
#endif // dictionr_h