GUISelectedStorage.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Storage for "selected" objects
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <unordered_set>
#include <string>
#include <map>
#include <fstream>
#include <utils/foxtools/fxheader.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);
 
    bool isSelected(const GUIGlObject* o);
 
    void select(GUIGlID id, bool update = true);
 
    void deselect(GUIGlID id);
 
    void deselect(GUIGlObjectType type, GUIGlID id);
 
    void toggleSelection(GUIGlID id);
 
    const std::unordered_set<GUIGlID>& getSelected() const;
 
    const std::unordered_set<GUIGlID>& getSelected(GUIGlObjectType type);
 
    void clear();
 
    void notifyChanged();
 
    std::string load(const std::string& filename, GUIGlObjectType type = GLO_MAX, std::ostream* dynamicNotFound = nullptr);
    std::string load(std::istream& strm, GUIGlObjectType type = GLO_MAX, std::ostream* dynamicNotFound = nullptr);
 
    std::set<GUIGlID> loadIDs(std::istream& strm, std::string& msgOut, GUIGlObjectType type = GLO_MAX, std::ostream* dynamicNotFound = nullptr, int maxErrors = 16);
 
    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::unordered_set<GUIGlID>& getSelected() const;
 
    private:
        std::unordered_set<GUIGlID> mySelected;
    };
 
    friend class SingleTypeSelections;
 
 
private:
    std::map<GUIGlObjectType, SingleTypeSelections> mySelections;
 
    std::unordered_set<GUIGlID> myAllSelected;
 
    UpdateTarget* myUpdateTarget;
 
    static void save(const std::string& filename, const std::unordered_set<GUIGlID>& ids);
};