inputrecord.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 inputrecord_h
#define inputrecord_h

#include <vector>
#include <list>
#include <string>

#include "logger.h" // for missing __func__ in MSC
#include "oofemcfg.h"
#include "irresulttype.h"

namespace oofem {
class IntArray;
class FloatArray;
class FloatMatrix;
class Dictionary;
class Range;
class ScalarFunction;

typedef const char *InputFieldType;

#define IR_IOERR(__keyword, __ir, __result) \
    __ir->report_error(this->giveClassName(), __func__, __keyword, __result, __FILE__, __LINE__);

#define IR_GIVE_FIELD(__ir, __value, __id) result = __ir->giveField(__value, __id); \
    if ( result != IRRT_OK ) { IR_IOERR(__id, __ir, result); }

#define IR_GIVE_OPTIONAL_FIELD(__ir, __value, __id) result = __ir->giveOptionalField(__value, __id); \
    if ( result != IRRT_OK ) { IR_IOERR(__id, __ir, result); }

#define IR_GIVE_RECORD_KEYWORD_FIELD(__ir, __name, __value) \
    result = __ir->giveRecordKeywordField(__name, __value); \
    if ( result != IRRT_OK ) { IR_IOERR("RecordIDField", __ir, result); }



class OOFEM_EXPORT InputRecord
{
public:
    InputRecord();
    InputRecord(const InputRecord &);
    virtual ~InputRecord() { }
    InputRecord &operator = ( const InputRecord & );

    virtual InputRecord *GiveCopy() = 0;

    virtual std :: string giveRecordAsString() const = 0;

    virtual IRResultType giveRecordKeywordField(std :: string &answer, int &value) = 0;
    virtual IRResultType giveRecordKeywordField(std :: string &answer) = 0;
    virtual IRResultType giveField(int &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(double &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(bool &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(std :: string &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(FloatArray &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(IntArray &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(FloatMatrix &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(std :: vector< std :: string > &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(Dictionary &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(std :: list< Range > &answer, InputFieldType id) = 0;
    virtual IRResultType giveField(ScalarFunction &function, InputFieldType id) = 0;

    IRResultType giveOptionalField(int &answer, InputFieldType id);
    IRResultType giveOptionalField(double &answer, InputFieldType id);
    IRResultType giveOptionalField(bool &answer, InputFieldType id);
    IRResultType giveOptionalField(std :: string &answer, InputFieldType id);
    IRResultType giveOptionalField(FloatArray &answer, InputFieldType id);
    IRResultType giveOptionalField(IntArray &answer, InputFieldType id);
    IRResultType giveOptionalField(FloatMatrix &answer, InputFieldType id);
    IRResultType giveOptionalField(std :: vector< std :: string > &answer, InputFieldType id);
    IRResultType giveOptionalField(Dictionary &answer, InputFieldType id);
    IRResultType giveOptionalField(std :: list< Range > &answer, InputFieldType id);
    IRResultType giveOptionalField(ScalarFunction &function, InputFieldType id);

    virtual bool hasField(InputFieldType id) = 0;

    const char *strerror(IRResultType);
    virtual void printYourself() = 0;

    virtual void report_error(const char *_class, const char *proc, InputFieldType id,
                              IRResultType result, const char *file, int line) = 0;

    virtual void finish(bool wrn = true) = 0;
};
} // end namespace oofem
#endif // inputrecord_h