FileBucket.h

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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
/****************************************************************************/
/// @file    FileBucket.h
/// @author  Pablo Alvarez Lopez
/// @date    Nov 2025
///
// class used for link Elements with their filenames
/****************************************************************************/
#pragma once
#include <config.h>

#include <string>
#include <vector>

// ===========================================================================
// class definitions
// ===========================================================================

class FileBucket {

public:
    /// @brief Files that this bucket can save
    enum class Type : int {
        SUMO_CONFIG =       1 << 0,     // Bucket for sumo configs (usually only one)
        NETEDIT_CONFIG =    1 << 1,     // Bucket for netedit configs (usually only one)
        NETCONVERT_CONFIG = 1 << 2,     // Bucket for netconvert configs (usually only one)
        NETWORK =           1 << 3,     // Bucket for network elements (usually only one)
        EDGETYPE =          1 << 4,     // Bucket for edge type (usually only one)
        TLS =               1 << 5,     // Bucket for traffic lights (usually only one)
        DEMAND =            1 << 6,     // Bucket for demand elements
        MEANDATA =          1 << 7,     // Bucket for meanData elements
        ADDITIONAL =        1 << 8,     // Bucket for additional elements (always after demand and meanData)
        DATA =              1 << 9,     // Bucket for data elements
        // prefixes
        NETEDIT_PREFIX =    1 << 10,    // Bucket for netedit prefix
        SUMO_PREFIX =       1 << 11,    // Bucket for sumo prefix
        NETCONVERT_PREFIX = 1 << 12,    // Bucket for netconvert prefix
        // other
        NOTHING =           1 << 13,    // Element is not saved in bucket
    };

    /// @brief Constructor for default bucket
    FileBucket(FileBucket::Type type);

    /// @brief Constructor
    FileBucket(FileBucket::Type type, const std::string filename);

    /// @brief destructor
    ~FileBucket();

    /// @brief get file type
    FileBucket::Type getType() const;

    /// @brief get filename
    const std::string& getFilename() const;

    /// @brief set filename
    void setFilename(const std::string& filename);

    /// @brief check if this is a default bucket
    bool isDefaultBucket() const;

    /// @brief function related with Elements
    /// @{

    /// @brief add element in bucket
    void addElement(const bool isTemplate);

    /// @brief remove element
    void removeElement(const bool isTemplate);

    /// @brief add default vClass
    void addDefaultVType();

    /// @brief remove default vClass
    void removeDefaultVType();

    /// @brief check number of elements (no templates)
    int getNumElements() const;

    /// @brief check if this bucket is empty
    bool isEmpty() const;

    /// @}

    /// @brief vector with all types managed in this get bucket handler
    static const std::vector<FileBucket::Type> types;

    /// @brief vector with all types and prefixes managed in this get bucket handler
    static const std::vector<FileBucket::Type> prefixes;

private:
    /// @brief type
    const FileBucket::Type myFileType;

    /// @brief filename
    std::string myFilename;

    /// @brief number of elements vinculated with this file bucket
    int myNumElements = 0;

    /// @brief number of templates vinculated with this file bucket
    int myNumTemplates = 0;

    /// @brief number of default vTypes vinculated with this file bucket
    int myNumDefaultVTypes = 0;

    /// @brief flag to indicate if this is a default bucket (it cannot be removed)
    const bool myDefaultBucket;

    /// @brief Invalidated default constructor.
    FileBucket() = delete;

    /// @brief Invalidated copy constructor.
    FileBucket(const FileBucket&) = delete;

    /// @brief Invalidated assignment operator
    FileBucket& operator=(const FileBucket& src) = delete;
};

/// @brief override type bit operator
constexpr FileBucket::Type operator|(FileBucket::Type a, FileBucket::Type b) {
    return static_cast<FileBucket::Type>(static_cast<int>(a) | static_cast<int>(b));
}

/// @brief override type bit operator
constexpr bool operator&(FileBucket::Type a, FileBucket::Type b) {
    return (static_cast<int>(a) & static_cast<int>(b)) != 0;
}