Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityTerminalConfiguration Class

class Esri::ArcGISRuntime::UtilityTerminalConfiguration

A utility network terminal configuration. More...

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

This class was introduced in Esri::ArcGISRuntime 100.6.

Public Functions

virtual ~UtilityTerminalConfiguration() override
QList<Esri::ArcGISRuntime::UtilityTerminalConfigurationPath *> configurationPaths() const
Esri::ArcGISRuntime::UtilityTerminalConfigurationPath *defaultConfigurationPath() const
Esri::ArcGISRuntime::UtilityTerminalDirectionality directionality() const
QString name() const
int terminalConfigurationId() const
QList<Esri::ArcGISRuntime::UtilityTerminal *> terminals() const

Detailed Description

Member Function Documentation

[override virtual] UtilityTerminalConfiguration::~UtilityTerminalConfiguration()

Destructor.

QList<Esri::ArcGISRuntime::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.

Esri::ArcGISRuntime::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.

Esri::ArcGISRuntime::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<Esri::ArcGISRuntime::UtilityTerminal *> UtilityTerminalConfiguration::terminals() const

Returns the list of UtilityTerminal objects in the terminal configuration.


Feedback on this topic?