Perform valve isolation trace

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 // [WriteFile Name=PerformValveIsolationTrace, Category=UtilityNetwork] // [Legal] // Copyright 2020 Esri. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // [Legal]  #ifdef PCH_BUILD #include "pch.hpp" #endif // PCH_BUILD  // sample headers #include "PerformValveIsolationTrace.h"  // ArcGIS Maps SDK headers #include "ArcGISRuntimeEnvironment.h" #include "Authentication/AuthenticationManager.h" #include "Authentication/ArcGISAuthenticationChallenge.h" #include "Authentication/TokenCredential.h" #include "ArcGISFeature.h" #include "ArcGISFeatureListModel.h" #include "Error.h" #include "ErrorException.h" #include "FeatureLayer.h" #include "GeometryEngine.h" #include "Graphic.h" #include "GraphicListModel.h" #include "GraphicsOverlay.h" #include "GraphicsOverlayListModel.h" #include "IdentifyLayerResult.h" #include "LayerListModel.h" #include "Map.h" #include "MapQuickView.h" #include "MapTypes.h" #include "Point.h" #include "Polyline.h" #include "QueryParameters.h" #include "ServiceFeatureTable.h" #include "SimpleMarkerSymbol.h" #include "SimpleRenderer.h" #include "SymbolTypes.h" #include "UtilityAssetGroup.h" #include "UtilityAssetType.h" #include "UtilityCategory.h" #include "UtilityCategoryComparison.h" #include "UtilityDomainNetwork.h" #include "UtilityElement.h" #include "UtilityElementTraceResult.h" #include "UtilityNetwork.h" #include "UtilityNetworkDefinition.h" #include "UtilityNetworkListModel.h" #include "UtilityNetworkSource.h" #include "UtilityNetworkTypes.h" #include "UtilityTerminal.h" #include "UtilityTerminalConfiguration.h" #include "UtilityTier.h" #include "UtilityTraceConfiguration.h" #include "UtilityTraceFilter.h" #include "UtilityTraceParameters.h" #include "UtilityTraceResultListModel.h"  // Qt headers #include <QFuture> #include <QUuid>  // Other headers #include "TaskCanceler.h"  using namespace Esri::ArcGISRuntime; using namespace Esri::ArcGISRuntime::Authentication;  namespace { const QString domainNetworkName = QStringLiteral("Pipeline"); const QString tierName = QStringLiteral("Pipe Distribution System"); const QString networkSourceName = QStringLiteral("Gas Device"); const QString assetGroupName = QStringLiteral("Meter"); const QString assetTypeName = QStringLiteral("Customer"); const QString globalId = QStringLiteral("{98A06E95-70BE-43E7-91B7-E34C9D3CB9FF}"); const QString sampleServer7Username = QStringLiteral("viewer01"); const QString sampleServer7Password = QStringLiteral("I68VGU^nMurF"); }  namespace { // Convenient RAII template struct that deletes all pointers in a given container. template <typename T> struct ScopedCleanup {  ScopedCleanup(const QList<T*>& list) : results(list) { }  ~ScopedCleanup() { qDeleteAll(results); }  const QList<T*>& results; }; }  PerformValveIsolationTrace::PerformValveIsolationTrace(QObject* parent /* = nullptr */):  ArcGISAuthenticationChallengeHandler(parent),  m_map(new Map(QUrl("https://sampleserver7.arcgisonline.com/portal/home/item.html?id=f439b4724bb54ac088a2c21eaf70da7b"), this)),  m_startingLocationOverlay(new GraphicsOverlay(this)),  m_filterBarriersOverlay(new GraphicsOverlay(this)),  m_graphicParent(new QObject()),  m_taskCanceler(std::make_unique<TaskCanceler>()) {  ArcGISRuntimeEnvironment::authenticationManager()->setArcGISAuthenticationChallengeHandler(this);   // disable UI while loading utility network  m_tasksRunning = true;  emit tasksRunningChanged();   connect(m_map, &Map::doneLoading, this, [this](const Error& error)  {  if (!error.isEmpty() || m_map->utilityNetworks()->isEmpty())  {  return;  }   m_utilityNetwork = m_map->utilityNetworks()->first();  m_utilityNetwork->load();  connectSignals();  }); }  PerformValveIsolationTrace::~PerformValveIsolationTrace() = default;  void PerformValveIsolationTrace::init() {  // Register the map view for QML  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");  qmlRegisterType<PerformValveIsolationTrace>("Esri.Samples", 1, 0, "PerformValveIsolationTraceSample"); }  MapQuickView* PerformValveIsolationTrace::mapView() const {  return m_mapView; }  // Set the view (created in QML) void PerformValveIsolationTrace::setMapView(MapQuickView* mapView) {  if (!mapView || mapView == m_mapView)  return;   m_mapView = mapView;  m_mapView->setMap(m_map);   connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent& mouseEvent)  {  if (m_map->loadStatus() != LoadStatus::Loaded)  return;   constexpr double tolerance = 10.0;  constexpr bool returnPopups = false;  m_clickPoint = m_mapView->screenToLocation(mouseEvent.position().x(), mouseEvent.position().y());  m_taskCanceler->addTask(m_mapView->identifyLayersAsync(mouseEvent.position(), tolerance, returnPopups).then(this, [this](const QList<IdentifyLayerResult*>& results)  {  // handle the identify results  onIdentifyLayersCompleted_(results);  }));  });   // apply renderers  SimpleMarkerSymbol* startingPointSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Cross, Qt::green, 25, this);  m_startingLocationOverlay->setRenderer(new SimpleRenderer(startingPointSymbol, this));   SimpleMarkerSymbol* filterBarrierSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::X, Qt::red, 25, this);  m_filterBarriersOverlay->setRenderer(new SimpleRenderer(filterBarrierSymbol, this));   m_mapView->graphicsOverlays()->append(m_startingLocationOverlay);  m_mapView->graphicsOverlays()->append(m_filterBarriersOverlay);   emit mapViewChanged(); }  QStringList PerformValveIsolationTrace::categoriesList() const {  if (!m_utilityNetwork)  return { };   if (m_utilityNetwork->loadStatus() != LoadStatus::Loaded)  return { };   const QList<UtilityCategory*> categories = m_utilityNetwork->definition()->categories();  QStringList strList;  for (UtilityCategory* category : categories)  {  strList << category->name();  }  return strList; }  void PerformValveIsolationTrace::performTrace() {  if (m_selectedIndex < 0)  return;   // disable UI while trace is run  m_tasksRunning = true;  emit tasksRunningChanged();   for (Layer* layer : *m_map->operationalLayers())  {  // clear previous selection from the feature layers  FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);  if (featureLayer)  featureLayer->clearSelection();  }   const QList<UtilityCategory*> categories = m_utilityNetwork->definition()->categories();   // get the selected utility category  if (categories[m_selectedIndex] != nullptr)  {  // set whether to include isolated features  m_traceConfiguration->setIncludeIsolatedFeatures(m_isolateFeatures);   UtilityTraceParameters* traceParameters = new UtilityTraceParameters(UtilityTraceType::Isolation, QList<UtilityElement*> {m_startingLocation}, this);  traceParameters->setTraceConfiguration(m_traceConfiguration);   // reset trace configuration filter barriers  m_traceConfiguration->setFilter(new UtilityTraceFilter(this));   // set the user selected filter barriers otherwise  // set the category comparison to the barriers of the configuration's trace filter  if (!m_filterBarriers.empty())  traceParameters->setFilterBarriers(m_filterBarriers);  else  {  UtilityCategory* selectedCategory = categories[m_selectedIndex];  UtilityCategoryComparison* categoryComparison = new UtilityCategoryComparison(selectedCategory, UtilityCategoryComparisonOperator::Exists, this);  traceParameters->traceConfiguration()->filter()->setBarriers(categoryComparison);  }   m_taskCanceler->addTask(m_utilityNetwork->traceAsync(traceParameters).then(this, [this](QList<UtilityTraceResult*>)  {  onTraceCompleted_();  }));  } }  void PerformValveIsolationTrace::onTraceCompleted_() {  // local paret to clean up UtilityElementTraceResult when we leave scope.  QObject localParent;   m_tasksRunning = false;  emit tasksRunningChanged();   UtilityTraceResultListModel* utilityTraceResultList = m_utilityNetwork->traceResult();   if (utilityTraceResultList->isEmpty())  {  m_noResults = true;  emit noResultsChanged();  return;  }   UtilityElementTraceResult* utilityElementTraceResult = dynamic_cast<UtilityElementTraceResult*>(utilityTraceResultList->at(0));  if (utilityElementTraceResult)  {  // given local parent to clean up once we leave scope  utilityElementTraceResult->setParent(&localParent);   const QList<UtilityElement*> utilityElementList = utilityElementTraceResult->elements(this);   // A convenience wrapper that deletes the contents of utilityElementList when we leave scope.  ScopedCleanup<UtilityElement> utilityElementListCleanUp(utilityElementList);   if (utilityElementList.empty())  {  m_noResults = true;  emit noResultsChanged();  return;  }   // iterate through the map's features  for (Layer* layer : *m_map->operationalLayers())  {  FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);  if (featureLayer)  {  // create query parameters to find features whose network source names match layer's feature table name  QueryParameters queryParameters;  QList<qint64> objectIds = {};   for (UtilityElement* utilityElement : utilityElementList)  {  const QString networkSourceName = utilityElement->networkSource()->name();  const QString featureTableName = featureLayer->featureTable()->tableName();  if (networkSourceName == featureTableName)  objectIds.append(utilityElement->objectId());  }  queryParameters.setObjectIds(objectIds);  m_taskCanceler->addTask(featureLayer->selectFeaturesAsync(queryParameters, SelectionMode::New));  }  }  } }  void PerformValveIsolationTrace::performReset() {  m_filterBarriersOverlay->graphics()->clear();  m_filterBarriers.clear();  m_traceConfiguration->setFilter(new UtilityTraceFilter(this));  m_graphicParent.reset(new QObject());   for (Layer* layer : *m_map->operationalLayers())  {  // clear previous selection from the feature layers  FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);  if (featureLayer)  featureLayer->clearSelection();  } }  void PerformValveIsolationTrace::connectSignals() {  connect(m_utilityNetwork, &UtilityNetwork::doneLoading, this, [this](const Error& error)  {  m_tasksRunning = false;  emit tasksRunningChanged();   if (!error.isEmpty())  {  qDebug() << error.message() << error.additionalMessage();  return;  }   if (m_utilityNetwork->loadStatus() != LoadStatus::Loaded)  return;   // get a trace configuration from a tier  UtilityNetworkDefinition* networkDefinition = m_utilityNetwork->definition();  UtilityDomainNetwork* domainNetwork = networkDefinition->domainNetwork(domainNetworkName);  if (domainNetwork)  {  UtilityTier* tier = domainNetwork->tier(tierName);  if (tier)  m_traceConfiguration = tier->defaultTraceConfiguration();  }   if (!m_traceConfiguration)  return;   // create a trace filter  m_traceConfiguration->setFilter(new UtilityTraceFilter(this));   // get a default starting location  UtilityNetworkSource* networkSource = networkDefinition->networkSource(networkSourceName);  if (networkSource)  {  UtilityAssetGroup* assetGroup = networkSource->assetGroup(assetGroupName);  if (assetGroup)  {  UtilityAssetType* assetType = assetGroup->assetType(assetTypeName);  if (assetType)  m_startingLocation = m_utilityNetwork->createElementWithAssetType(assetType, QUuid(globalId), nullptr, this);  }  }   if (!m_startingLocation)  return;   // display starting location  m_taskCanceler->addTask(m_utilityNetwork->featuresForElementsAsync(QList<UtilityElement*> {m_startingLocation}).then(this, [this](QList<ArcGISFeature*>)  {  // display starting location  ArcGISFeatureListModel* elementFeaturesList = m_utilityNetwork->featuresForElementsResult();  const Point startingLocationGeometry = geometry_cast<Point>(elementFeaturesList->first()->geometry());  Graphic* graphic = new Graphic(startingLocationGeometry, m_graphicParent.get());  m_startingLocationOverlay->graphics()->append(graphic);   constexpr double scale = 3000.0;  m_taskCanceler->addTask(m_mapView->setViewpointCenterAsync(startingLocationGeometry, scale));  m_tasksRunning = false;  emit tasksRunningChanged();  }));   // populate the combo box choices  m_categoriesList = categoriesList();  emit categoriesListChanged();  }); }  bool PerformValveIsolationTrace::noResults() const {  return m_noResults; }  bool PerformValveIsolationTrace::tasksRunning() const {  return m_tasksRunning; }  void PerformValveIsolationTrace::onIdentifyLayersCompleted_(const QList<IdentifyLayerResult*>& results) {  // A convenience wrapper that deletes the contents of results when we leave scope.  ScopedCleanup<IdentifyLayerResult> resultsScopedCleanup(results);   // could not identify location  if (results.isEmpty())  return;   const IdentifyLayerResult* result = results[0];  ArcGISFeature* feature = static_cast<ArcGISFeature*>(std::as_const(result)->geoElements()[0]);  m_element = m_utilityNetwork->createElementWithArcGISFeature(feature);   const UtilityNetworkSourceType elementSourceType = m_element->networkSource()->sourceType();   if (elementSourceType == UtilityNetworkSourceType::Junction)  {  const QList<UtilityTerminal*> terminals = m_element->assetType()->terminalConfiguration()->terminals();   if (terminals.size() > 1)  {  m_terminals.clear();  for (UtilityTerminal* terminal : terminals)  {  m_terminals.append(terminal->name());  }  emit terminalsChanged();  return;  }  }  else if (elementSourceType == UtilityNetworkSourceType::Edge)  {  if (feature->geometry().geometryType() == GeometryType::Polyline)  {  const Polyline line = geometry_cast<Polyline>(GeometryEngine::removeZ(feature->geometry()));  // Set how far the element is along the edge.  const double fraction = GeometryEngine::fractionAlong(line, m_clickPoint, -1);  m_element->setFractionAlongEdge(fraction);  }  }   m_filterBarriersOverlay->graphics()->append(new Graphic(m_clickPoint, m_graphicParent.get()));  m_filterBarriers.append(m_element); }  void PerformValveIsolationTrace::selectedTerminal(int index) {  UtilityTerminal* selectedTerminal = m_element->assetType()->terminalConfiguration()->terminals().at(index);  m_element->setTerminal(selectedTerminal);   m_filterBarriersOverlay->graphics()->append(new Graphic(m_clickPoint, m_graphicParent.get()));  m_filterBarriers.append(m_element); }  void PerformValveIsolationTrace::handleArcGISAuthenticationChallenge(ArcGISAuthenticationChallenge* challenge) {  TokenCredential::createWithChallengeAsync(challenge, sampleServer7Username, sampleServer7Password, {}, this).then(this, [challenge](TokenCredential* tokenCredential)  {  challenge->continueWithCredential(tokenCredential);  }).onFailed(this, [challenge](const ErrorException& e)  {  challenge->continueWithError(e.error());  }); }