Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityTerminalConfiguration Class


A utility network terminal configuration. More...

Header: #include <UtilityTerminalConfiguration>
Since: Esri::ArcGISRuntime 100.6
Inherits: Object

Public Functions

QList<UtilityTerminalConfigurationPath *> configurationPaths() const
UtilityTerminalConfigurationPath *defaultConfigurationPath() const
UtilityTerminalDirectionality directionality() const
QString name() const
int terminalConfigurationId() const
QList<UtilityTerminal *> terminals() const
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

A utility network terminal configuration.

Member Function Documentation



QList<UtilityTerminalConfigurationPath *> UtilityTerminalConfiguration::configurationPaths() const

Returns the configuration paths that constrain the flow paths between pairs of terminals.

Of the set of possible paths that can be drawn between a set of terminals, these paths are the valid ones. If this UtilityTerminalConfiguration instance does not have configuration paths defined, an empty list is returned.

This function was introduced in Esri::ArcGISRuntime 100.8.

UtilityTerminalConfigurationPath *UtilityTerminalConfiguration::defaultConfigurationPath() const

Returns the default UtilityTerminalConfigurationPath defined for this terminal configuration.

If this property returns nullptr, configuration paths do not apply to this terminal configuration.

This function was introduced in Esri::ArcGISRuntime 100.8.

UtilityTerminalDirectionality UtilityTerminalConfiguration::directionality() const

Returns the directionality setting of terminals on a device.

Directionality specifies whether flow through a device is one-way or bidirectional.

This function was introduced in Esri::ArcGISRuntime 100.8.

QString UtilityTerminalConfiguration::name() const

Returns the name of the terminal configuration.

int UtilityTerminalConfiguration::terminalConfigurationId() const

Returns the ID of the terminal configuration.

QList<UtilityTerminal *> UtilityTerminalConfiguration::terminals() const

Returns the list of UtilityTerminal objects in the terminal configuration.

Feedback on this topic?