SUMOSAXAttributes.h

Go to the documentation of this file.

/****************************************************************************/
// Encapsulated SAX-Attributes
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2012 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO 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 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef SUMOSAXAttributes_h
#define SUMOSAXAttributes_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <vector>
#include <utils/common/SUMOTime.h>
#include <utils/common/UtilExceptions.h>


// ===========================================================================
// class definitions
// ===========================================================================
class SUMOSAXAttributes {
public:
    /* @brief Constructor
     * @param[in] tagName The name of the parsed object type; used for error message generation
     */
    SUMOSAXAttributes(const std::string& objectType) ;


    virtual ~SUMOSAXAttributes() { }


    int getIntReporting(int attr, const char* objectid, bool& ok,
                        bool report = true) const ;


    int getOptIntReporting(int attr, const char* objectid, bool& ok,
                           int defaultValue, bool report = true) const ;



    SUMOReal getSUMORealReporting(int attr, const char* objectid, bool& ok,
                                  bool report = true) const ;



    SUMOReal getOptSUMORealReporting(int attr, const char* objectid, bool& ok,
                                     SUMOReal defaultValue, bool report = true) const ;



    bool getBoolReporting(int attr,  const char* objectid, bool& ok,
                          bool report = true) const ;



    bool getOptBoolReporting(int attr, const char* objectid, bool& ok,
                             bool defaultValue, bool report = true) const ;



    std::string getStringReporting(int attr, const char* objectid, bool& ok,
                                   bool report = true) const ;



    std::string getOptStringReporting(int attr, const char* objectid, bool& ok,
                                      const std::string& defaultValue, bool report = true) const ;



    SUMOTime getSUMOTimeReporting(int attr, const char* objectid, bool& ok,
                                  bool report = true) const ;



    SUMOTime getOptSUMOTimeReporting(int attr, const char* objectid, bool& ok,
                                     SUMOTime defaultValue, bool report = true) const ;









    virtual bool hasAttribute(int id) const = 0;


    virtual bool hasAttribute(const std::string& id) const = 0;


    virtual bool getBool(int id) const throw(EmptyData, BoolFormatException) = 0;

    virtual bool getBoolSecure(int id, bool val) const throw(EmptyData) = 0;


    virtual int getInt(int id) const throw(EmptyData, NumberFormatException) = 0;


    virtual int getIntSecure(int id, int def) const throw(EmptyData, NumberFormatException) = 0;


    virtual std::string getString(int id) const throw(EmptyData) = 0;


    virtual std::string getStringSecure(int id,
                                        const std::string& def) const throw(EmptyData) = 0;


    virtual SUMOReal getFloat(int id) const throw(EmptyData, NumberFormatException) = 0;

    virtual SUMOReal getFloatSecure(int id, SUMOReal def) const throw(EmptyData, NumberFormatException) = 0;


    virtual SUMOReal getFloat(const std::string& id) const throw(EmptyData, NumberFormatException) = 0;


    virtual std::string getStringSecure(const std::string& id,
                                        const std::string& def) const = 0;
    //}


    virtual std::string getName(int attr) const = 0;


    static void parseStringVector(const std::string& def, std::vector<std::string> &into) ;


    const std::string& getObjectType() const {
        return myObjectType;
    }


    static const std::string ENCODING;


protected:
    void emitUngivenError(const std::string& attrname, const char* objectid) const ;
    void emitEmptyError(const std::string& attrname, const char* objectid) const ;
    void emitFormatError(const std::string& attrname, const std::string& type, const char* objectid) const ;

private:
    static bool myHaveInformedAboutDeprecatedDivider;

private:
    SUMOSAXAttributes(const SUMOSAXAttributes& src);

    SUMOSAXAttributes& operator=(const SUMOSAXAttributes& src);

    std::string myObjectType;

};


#endif

/****************************************************************************/