;

UtilityNamedTraceConfiguration Class

  • UtilityNamedTraceConfiguration
  • class Esri::ArcGISRuntime::UtilityNamedTraceConfiguration

    A set of predefined trace options that can be used by UtilityTraceParameters to simplify configuring and running a trace operation. More...

    Header: #include <UtilityNamedTraceConfiguration>
    Since: Esri::ArcGISRuntime 100.11
    Inherits: Esri::ArcGISRuntime::Object

    This class was introduced in Esri::ArcGISRuntime 100.11.

    Public Functions

    virtual ~UtilityNamedTraceConfiguration() override
    QString creator() const
    Esri::ArcGISRuntime::UtilityTraceConfiguration *defaultTraceConfiguration() const
    QString description() const
    QUuid globalId() const
    Esri::ArcGISRuntime::UtilityMinimumStartingLocations minimumStartingLocations() const
    QString name() const
    QList<Esri::ArcGISRuntime::UtilityTraceResultType> resultTypes() const
    QStringList tags() const
    Esri::ArcGISRuntime::UtilityTraceType traceType() const

    Detailed Description

    Named trace configurations are created in the utility network and allow clients to perform trace analytics without needing to understand the data model. Applications can simply allow the user to choose from a set of named trace configurations that provide tracing capabilities. The set can be configured for different workflows, and a single application can be used by multiple customers and even across multiple problem domains.

    See also Map::namedTraceConfigurationsFromUtilityNetwork(UtilityNetwork) and UtilityNetwork::queryNamedTraceConfigurations(UtilityNamedTraceConfigurationQueryParameters).

    Member Function Documentation

    [override virtual] UtilityNamedTraceConfiguration::~UtilityNamedTraceConfiguration()

    Destructor.

    QString UtilityNamedTraceConfiguration::creator() const

    Returns the creator of the named trace configuration.

    The creator will be the active portal user when the named trace configuration was created.

    Esri::ArcGISRuntime::UtilityTraceConfiguration *UtilityNamedTraceConfiguration::defaultTraceConfiguration() const

    Returns a copy of the UtilityTraceConfiguration defined for this UtilityNamedTraceConfiguration.

    This function was introduced in Esri::ArcGISRuntime 100.12.

    QString UtilityNamedTraceConfiguration::description() const

    Returns the description of the named trace configuration.

    QUuid UtilityNamedTraceConfiguration::globalId() const

    Returns the global ID of the named trace configuration.

    Esri::ArcGISRuntime::UtilityMinimumStartingLocations UtilityNamedTraceConfiguration::minimumStartingLocations() const

    Returns the minimum number of starting locations required for this trace type (e.g., the shortest path trace requires 2).

    See also UtilityMinimumStartingLocations.

    QString UtilityNamedTraceConfiguration::name() const

    Returns the name of the named trace configuration.

    QList<Esri::ArcGISRuntime::UtilityTraceResultType> UtilityNamedTraceConfiguration::resultTypes() const

    Returns the result types returned by this named trace configuration.

    See also UtilityTraceResultType.

    QStringList UtilityNamedTraceConfiguration::tags() const

    Returns the user tags of the named trace configuration.

    Esri::ArcGISRuntime::UtilityTraceType UtilityNamedTraceConfiguration::traceType() const

    Returns the UtilityTraceType used by the named trace configuration.

    See also UtilityTraceType.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.