GUISelectedStorage.h

Go to the documentation of this file.

/****************************************************************************/
// Storage for "selected" objects
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright (C) 2001-2011 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   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.
//
/****************************************************************************/
#ifndef GUISelectedStorage_h
#define GUISelectedStorage_h


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

#include <set>
#include <string>
#include <map>
#include <fstream>
#include <fx.h>
#include <utils/common/UtilExceptions.h>
#include <utils/gui/globjects/GUIGlObject.h>


// ===========================================================================
// class declarations
// ===========================================================================
class OutputDevice;


// ===========================================================================
// class definitions
// ===========================================================================
class GUISelectedStorage {

public:
    class UpdateTarget {
    public:
        virtual ~UpdateTarget() {};
        virtual void selectionUpdated() = 0;
    };

public:
    GUISelectedStorage();


    ~GUISelectedStorage();


    bool isSelected(GUIGlObjectType type, GUIGlID id);


    void select(GUIGlID id, bool update=true);


    void deselect(GUIGlID id);


    void toggleSelection(GUIGlID id);


    const std::set<GUIGlID> &getSelected() const;


    const std::set<GUIGlID> &getSelected(GUIGlObjectType type);


    void clear();


    std::string load(const std::string& filename, GUIGlObjectType type = GLO_MAX);


    std::set<GUIGlID> loadIDs(const std::string& filename, std::string& msgOut, GUIGlObjectType type = GLO_MAX);


    void save(GUIGlObjectType type, const std::string& filename);

    void save(const std::string& filename) const;


    void add2Update(UpdateTarget* updateTarget);


    void remove2Update();


    class SingleTypeSelections {
    public:
        SingleTypeSelections();

        ~SingleTypeSelections();


        bool isSelected(GUIGlID id);


        void select(GUIGlID id);


        void deselect(GUIGlID id);


        void clear();


        void save(const std::string& filename);


        const std::set<GUIGlID> &getSelected() const;

    private:
        std::set<GUIGlID> mySelected;

    };
    friend class SingleTypeSelections;


private:
    std::map<GUIGlObjectType, SingleTypeSelections> mySelections;

    std::set<GUIGlID> myAllSelected;

    UpdateTarget* myUpdateTarget;

    /* @brief load items into the given set, optionally restricting to type
     */
    std::string load(GUIGlObjectType type, const std::string& filename, bool restrictType, std::set<GUIGlID>& into);


    static void save(const std::string& filename, const std::set<GUIGlID>& ids);

};


#endif

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