refactoring refs #12 to enable larger attribute mask. refs #14447

eclipse-sumo · Mar 1, 2024 · c5ca904 · c5ca904
1 parent 6f8e371
commit c5ca904
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 15 deletions.
diff --git a/src/microsim/devices/MSDevice_FCD.cpp b/src/microsim/devices/MSDevice_FCD.cpp
@@ -34,13 +34,6 @@
 #include <microsim/MSVehicle.h>
 #include "MSDevice_FCD.h"
 
-// some attributes are not written by default and must be enabled via option fcd-output.attributes
-const long long int MSDevice_FCD::myDefaultMask(~(
-            ((long long int)1 << SUMO_ATTR_VEHICLE) |
-            ((long long int)1 << SUMO_ATTR_ODOMETER) |
-            ((long long int)1 << SUMO_ATTR_SPEED_LAT) |
-            ((long long int)1 << SUMO_ATTR_POSITION_LAT)
-        ));
 
 // ===========================================================================
 // static members
@@ -50,7 +43,7 @@ std::vector<PositionVector> MSDevice_FCD::myShape4Filters;
 bool MSDevice_FCD::myEdgeFilterInitialized(false);
 bool MSDevice_FCD::myShapeFilterInitialized(false);
 bool MSDevice_FCD::myShapeFilterDesired(false);
-long long int MSDevice_FCD::myWrittenAttributes(myDefaultMask);
+SumoXMLAttrMask MSDevice_FCD::myWrittenAttributes(getDefaultMask());
 
 // ===========================================================================
 // method definitions
@@ -96,6 +89,22 @@ MSDevice_FCD::MSDevice_FCD(SUMOVehicle& holder, const std::string& id) :
 MSDevice_FCD::~MSDevice_FCD() {
 }
 
+
+SumoXMLAttrMask
+MSDevice_FCD::getDefaultMask() {
+    SumoXMLAttrMask mask;
+    // set all bits to 1
+    mask.set();
+    // some attributes are not written by default and must be enabled via option fcd-output.attributes
+    // (or with an explicit attribute list)
+    mask.reset(SUMO_ATTR_VEHICLE);
+    mask.reset(SUMO_ATTR_ODOMETER);
+    mask.reset(SUMO_ATTR_SPEED_LAT);
+    mask.reset(SUMO_ATTR_POSITION_LAT);
+    return mask;
+}
+
+
 bool
 MSDevice_FCD::shapeFilter(const SUMOTrafficObject* veh) {
     // lazily build the shape filter in the case where route file is loaded as an additional file
@@ -190,7 +199,7 @@ MSDevice_FCD::cleanup() {
     myEdgeFilterInitialized = false;
     myShapeFilterInitialized = false;
     myShapeFilterDesired = false;
-    myWrittenAttributes = myDefaultMask;
+    myWrittenAttributes = getDefaultMask();
 }
 
 

diff --git a/src/microsim/devices/MSDevice_FCD.h b/src/microsim/devices/MSDevice_FCD.h
@@ -84,7 +84,7 @@ class MSDevice_FCD : public MSVehicleDevice {
         return myEdgeFilter;
     }
 
-    static long long int getWrittenAttributes() {
+    static SumoXMLAttrMask getWrittenAttributes() {
         return myWrittenAttributes;
     }
 
@@ -122,8 +122,8 @@ class MSDevice_FCD : public MSVehicleDevice {
     static bool myShapeFilterDesired;
 
     /// @brief bit mask for checking attributes to be written
-    static long long int myWrittenAttributes;
-    static const long long int myDefaultMask;
+    static SumoXMLAttrMask myWrittenAttributes;
+    static SumoXMLAttrMask getDefaultMask();
 
 private:
     /// @brief Invalidated copy constructor.

diff --git a/src/microsim/output/MSFCDExport.cpp b/src/microsim/output/MSFCDExport.cpp
@@ -54,7 +54,7 @@ MSFCDExport::write(OutputDevice& of, SUMOTime timestep, bool elevation) {
     if ((period > 0 && (timestep - begin) % period != 0) || timestep < begin) {
         return;
     }
-    const long long int mask = MSDevice_FCD::getWrittenAttributes();
+    const SumoXMLAttrMask mask = MSDevice_FCD::getWrittenAttributes();
     const bool maskSet = oc.isSet("fcd-output.attributes");
     const bool useGeo = oc.getBool("fcd-output.geo");
     const bool signals = oc.getBool("fcd-output.signals") || (maskSet && of.useAttribute(SUMO_ATTR_SIGNALS, mask));
@@ -223,7 +223,7 @@ MSFCDExport::hasOwnOutput(const MSTransportable* p, bool filter, bool shapeFilte
 void
 MSFCDExport::writeTransportable(OutputDevice& of, const MSEdge* e, MSTransportable* p, const SUMOVehicle* v,
                                 bool filter, bool shapeFilter, bool inRadius,
-                                SumoXMLTag tag, bool useGeo, bool elevation, long long int mask) {
+                                SumoXMLTag tag, bool useGeo, bool elevation, SumoXMLAttrMask mask) {
     if (!hasOwnOutput(p, filter, shapeFilter, inRadius)) {
         return;
     }

diff --git a/src/microsim/output/MSFCDExport.h b/src/microsim/output/MSFCDExport.h
@@ -61,7 +61,7 @@ class MSFCDExport {
     /// @brief write transportable
     static void writeTransportable(OutputDevice& of, const MSEdge* e, MSTransportable* p, const SUMOVehicle* v,
                                    bool filter, bool shapeFilter, bool inRadius,
-                                   SumoXMLTag tag, bool useGeo, bool elevation, long long int mask);
+                                   SumoXMLTag tag, bool useGeo, bool elevation, SumoXMLAttrMask mask);
 
     static bool isVisible(const SUMOVehicle* veh);
     static bool hasOwnOutput(const SUMOVehicle* veh, bool filter, bool shapeFilter, bool isInRadius = false);

diff --git a/src/utils/iodevices/OutputDevice.h b/src/utils/iodevices/OutputDevice.h
@@ -260,6 +260,10 @@ class OutputDevice {
         return (attributeMask & ((long long int)1 << attr)) != 0;
     }
 
+    inline bool useAttribute(const SumoXMLAttr attr, SumoXMLAttrMask attributeMask) const {
+        return attributeMask.test(attr);
+    }
+
     /** @brief writes a named attribute unless filtered
      *
      * @param[in] attr The attribute (name)
@@ -275,6 +279,14 @@ class OutputDevice {
         }
         return *this;
     }
+    template <typename T>
+    OutputDevice& writeOptionalAttr(const SumoXMLAttr attr, const T& val, SumoXMLAttrMask attributeMask) {
+        assert((int)attr <= (int)attributeMask.size());
+        if (attributeMask.none() || useAttribute(attr, attributeMask)) {
+            PlainXMLFormatter::writeAttr(getOStream(), attr, val);
+        }
+        return *this;
+    }
 
 
     /** @brief writes an arbitrary attribute

diff --git a/src/utils/xml/SUMOXMLDefinitions.h b/src/utils/xml/SUMOXMLDefinitions.h
@@ -24,6 +24,7 @@
 /****************************************************************************/
 #pragma once
 #include <config.h>
+#include <bitset>
 
 #include <utils/common/StringBijection.h>
 
@@ -534,6 +535,7 @@ enum SumoXMLTag {
     /// @}
 };
 
+typedef std::bitset<96> SumoXMLAttrMask;
 
 /**
  * @enum SumoXMLAttr