Create load report

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 // [WriteFile Name=CreateLoadReport, Category=UtilityNetwork] // [Legal] // Copyright 2021 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 "CreateLoadReport.h"  // ArcGIS Maps SDK headers #include "ArcGISRuntimeEnvironment.h" #include "Authentication/AuthenticationManager.h" #include "Authentication/ArcGISAuthenticationChallenge.h" #include "Authentication/TokenCredential.h" #include "CodedValueDomain.h" #include "ErrorException.h" #include "MapQuickView.h" #include "MapTypes.h" #include "ServiceGeodatabase.h" #include "UtilityAssetGroup.h" #include "UtilityAssetType.h" #include "UtilityCategory.h" #include "UtilityCategoryComparison.h" #include "UtilityDomainNetwork.h" #include "UtilityElementTraceResult.h" #include "UtilityFunctionTraceResult.h" #include "UtilityNetwork.h" #include "UtilityNetworkAttribute.h" #include "UtilityNetworkAttributeComparison.h" #include "UtilityNetworkDefinition.h" #include "UtilityNetworkSource.h" #include "UtilityNetworkTypes.h" #include "UtilityTerminal.h" #include "UtilityTerminalConfiguration.h" #include "UtilityTier.h" #include "UtilityTraceConfiguration.h" #include "UtilityTraceFunction.h" #include "UtilityTraceFunctionListModel.h" #include "UtilityTraceFunctionOutput.h" #include "UtilityTraceOrCondition.h" #include "UtilityTraceParameters.h" #include "UtilityTraceResultListModel.h" #include "UtilityTraversability.h"  // Qt headers #include <QFuture>  using namespace Esri::ArcGISRuntime; using namespace Esri::ArcGISRuntime::Authentication;  CreateLoadReport::CreateLoadReport(QObject* parent /* = nullptr */):  ArcGISAuthenticationChallengeHandler(parent) {  ArcGISRuntimeEnvironment::authenticationManager()->setArcGISAuthenticationChallengeHandler(this);   m_networkSourceName = "Electric Distribution Device";  m_assetGroupName = "Circuit Breaker";  m_assetTypeName = "Three Phase";  m_terminalName = "Load";  m_globalId = "{1CAF7740-0BF4-4113-8DB2-654E18800028}";  m_domainNetworkName = "ElectricDistribution";  m_tierName = "Medium Voltage Radial";  m_serviceCategoryName = "ServicePoint";  m_loadNetworkAttributeName = "Service Load";  m_phasesNetworkAttributeName = "Phases Current";  m_sampleStatus = CreateLoadReport::SampleNotLoaded;   m_utilityNetwork = new UtilityNetwork(new ServiceGeodatabase(m_featureLayerUrl, this), this);   connect(m_utilityNetwork, &UtilityNetwork::loadStatusChanged, this, [this]()  {  if (m_utilityNetwork->loadStatus() == LoadStatus::Loaded)  {  m_utilityAssetType = m_utilityNetwork  ->definition()  ->networkSource(m_networkSourceName)  ->assetGroup(m_assetGroupName)  ->assetType(m_assetTypeName);   m_utilityTier = m_utilityNetwork  ->definition()  ->domainNetwork(m_domainNetworkName)  ->tier(m_tierName);   // Create a UtilityElement from the UtilityAssetType to use as the starting location  m_startingLocation = createStartingLocation();   // Get a default trace configuration from a tier in the network  m_traceConfiguration = createDefaultTraceConfiguration();   // Create a base condition to compare against  m_baseCondition = dynamic_cast<UtilityTraceConditionalExpression*>(m_utilityTier->defaultTraceConfiguration()->traversability()->barriers());   // Create downstream trace parameters with function outputs  m_traceParameters = new UtilityTraceParameters(UtilityTraceType::Downstream, {m_startingLocation}, this);  m_traceParameters->setResultTypes({UtilityTraceResultType::Elements, UtilityTraceResultType::FunctionOutputs});  // Assign the trace configuration to trace parameters.  m_traceParameters->setTraceConfiguration(m_traceConfiguration);   // Create a list of possible phases from a given network attribute  m_phaseList = createPhaseList();   m_sampleStatus = CreateLoadReport::SampleReady;  emit sampleStatusChanged();  }  else if (m_utilityNetwork->loadStatus() == LoadStatus::FailedToLoad)  {  m_sampleStatus = CreateLoadReport::SampleError;  emit sampleStatusChanged();  }  });   m_utilityNetwork->load(); }  UtilityElement* CreateLoadReport::createStartingLocation() {  if (!m_utilityAssetType)  return nullptr;   const QList<UtilityTerminal*> utilityTerminals = m_utilityAssetType->terminalConfiguration()->terminals();  if (!utilityTerminals.first())  return nullptr;   UtilityTerminal* loadTerminal = nullptr;   for (UtilityTerminal* utilityTerminal : utilityTerminals)  {  // Set the terminal for the location. (For our case, use the "Load" terminal.)  if (utilityTerminal->name() == m_terminalName)  {  loadTerminal = utilityTerminal;  break;  }  }   if (!loadTerminal)  return nullptr;   return m_utilityNetwork->createElementWithAssetType(m_utilityAssetType, QUuid(m_globalId), loadTerminal, this); }  UtilityTraceConfiguration* CreateLoadReport::createDefaultTraceConfiguration() {  UtilityTraceConfiguration* traceConfig = m_utilityTier->defaultTraceConfiguration();   // Service Category for counting total customers  UtilityCategory* servicePointCategory = getUtilityCategory(m_serviceCategoryName);   // The load attribute for counting total load.  UtilityNetworkAttribute* serviceLoadAttribute = m_utilityNetwork->definition()->networkAttribute(m_loadNetworkAttributeName);   // Create a comparison to check the existence of service points.  UtilityCategoryComparison* serviceCategoryComparison = new UtilityCategoryComparison(servicePointCategory, UtilityCategoryComparisonOperator::Exists, this);  UtilityTraceFunction* addLoadAttributeFunction = new UtilityTraceFunction(UtilityTraceFunctionType::Add, serviceLoadAttribute, serviceCategoryComparison, this);   traceConfig->functions()->clear();   // Create function input and output condition.  traceConfig->functions()->append(addLoadAttributeFunction);  traceConfig->setOutputCondition(serviceCategoryComparison);   // Set to false to ensure that service points with incorrect phasing  // (which therefore act as barriers) are not counted with results.  traceConfig->setIncludeBarriers(false);   return traceConfig; }  UtilityCategory* CreateLoadReport::getUtilityCategory(const QString& categoryName) {  const QList<UtilityCategory*> utilityCategories = m_utilityNetwork->definition()->categories();   for (UtilityCategory* utilityCategory : utilityCategories)  {  if (utilityCategory->name() == categoryName)  return utilityCategory;  }  return nullptr; }  QList<CodedValue> CreateLoadReport::createPhaseList() {  // The phase attribute for getting total phase current load.  m_phasesCurrentAttribute = m_utilityNetwork->definition()->networkAttribute(m_phasesNetworkAttributeName);   // Get possible coded phase values from the attributes.  if (m_phasesCurrentAttribute->domain().domainType() == DomainType::CodedValueDomain)  {  const CodedValueDomain cvd = CodedValueDomain(m_phasesCurrentAttribute->domain());  QList<CodedValue> codedValues = cvd.codedValues();   return codedValues;  }   return {}; }  void CreateLoadReport::runReport(const QStringList& selectedPhaseNames) {  m_sampleStatus = CreateLoadReport::SampleBusy;  emit sampleStatusChanged();   QVector<CodedValue> activeValues;  for (const CodedValue& codedValue : std::as_const(m_phaseList))  {  if (selectedPhaseNames.contains(codedValue.name()))  activeValues.append(codedValue);   // Reset the report values  m_phaseCust.remove(codedValue.name());  m_phaseLoad.remove(codedValue.name());   emit loadReportUpdated();  }  m_traceRequestCount = activeValues.size();  for (const CodedValue& codedValue : activeValues)  {  setUtilityTraceOrconditionWithCodedValue(codedValue);  m_utilityNetwork->traceAsync(m_traceParameters).then(this, [this, codedValue](QList<UtilityTraceResult*>)  {  onTraceCompleted_(codedValue.name());  });  }   // If no phases were selected then the sample was reset and can be marked ready  if (selectedPhaseNames.size() == 0) {  m_sampleStatus = CreateLoadReport::SampleReady;  emit sampleStatusChanged();  } }  void CreateLoadReport::setUtilityTraceOrconditionWithCodedValue(CodedValue codedValue) {  if (!m_baseCondition)  return;   // Create a conditional expression with the CodedValue  UtilityNetworkAttributeComparison* utilityNetworkAttributeComparison =  new UtilityNetworkAttributeComparison(  m_phasesCurrentAttribute,  UtilityAttributeComparisonOperator::DoesNotIncludeAny,  codedValue.code(), this);   // Chain it with the base condition using an OR operator.  UtilityTraceOrCondition* utilityTraceOrCondition = new UtilityTraceOrCondition(m_baseCondition, utilityNetworkAttributeComparison, this);  m_traceParameters->traceConfiguration()->traversability()->setBarriers(utilityTraceOrCondition); }  void CreateLoadReport::onTraceCompleted_(const QString& codedValueName) {  UtilityTraceResultListModel* results = m_utilityNetwork->traceResult();   for (UtilityTraceResult* result : *results)  {  // Get the total customers from the UtilityElementTraceResult  if (UtilityElementTraceResult* elementResult = dynamic_cast<UtilityElementTraceResult*>(result))  m_phaseCust[codedValueName] = elementResult->elements(this).size();   // Get the total load from the UtilityFunctionTraceResult  else if (UtilityFunctionTraceResult* functionResult = dynamic_cast<UtilityFunctionTraceResult*>(result))  m_phaseLoad[codedValueName] = std::as_const(functionResult)->functionOutputs().first()->result().toInt();  }   emit loadReportUpdated();  // If the trace request count is zero, all trace tasks have completed  if ((--m_traceRequestCount) == 0)  {  m_sampleStatus = CreateLoadReport::SampleReady;  emit sampleStatusChanged();  } }  CreateLoadReport::~CreateLoadReport() = default;  void CreateLoadReport::init() {  qmlRegisterType<CreateLoadReport>("Esri.Samples", 1, 0, "CreateLoadReportSample"); }  void CreateLoadReport::addPhase(const QString& phaseToAdd) {  m_activePhases.append(phaseToAdd); }  QVariantMap CreateLoadReport::phaseCust() {  return m_phaseCust; }  QVariantMap CreateLoadReport::phaseLoad() {  return m_phaseLoad; }  int CreateLoadReport::sampleStatus() {  return m_sampleStatus; }  void CreateLoadReport::handleArcGISAuthenticationChallenge(ArcGISAuthenticationChallenge* challenge) {  TokenCredential::createWithChallengeAsync(challenge, "viewer01", "I68VGU^nMurF", {}, this).then(this, [challenge](TokenCredential* tokenCredential)  {  challenge->continueWithCredential(tokenCredential);  }).onFailed(this, [challenge](const ErrorException& e)  {  challenge->continueWithError(e.error());  }); }