Skip To Content ArcGIS for Developers Sign In Dashboard

AttributeParameterValue Class


A placeholder for attribute values that can change for a particular network analysis. More...

Header: #include <AttributeParameterValue>
Since: Esri::ArcGISRuntime 100.0

Public Functions

AttributeParameterValue(const AttributeParameterValue &other)
AttributeParameterValue(AttributeParameterValue &&other)
QString attributeName() const
QString parameterName() const
QVariant parameterValue() const
void setAttributeName(const QString &attributeName)
void setParameterName(const QString &parameterName)
void setParameterValue(const QVariant &parameterValue)
AttributeParameterValue &operator=(const AttributeParameterValue &other)
AttributeParameterValue &operator=(AttributeParameterValue &&other)

Detailed Description

A placeholder for attribute values that can change for a particular network analysis.

Network attribute values sometimes depend on variable conditions. For example, a vehicle's height can determine if a road segment with a low overpass is traversable or not. Present weather conditions may scale down travel speeds and thus affect network time costs. These variables can be overridden with AttributeParameterValues when used in conjunction with a TravelMode for solving network analysis tasks.

See the Network Analyst documentation for further conceptual details.

Member Function Documentation


Default constructor.

AttributeParameterValue::AttributeParameterValue(const AttributeParameterValue &other)

Copy constructor from other AttributeParameterValue.

AttributeParameterValue::AttributeParameterValue(AttributeParameterValue &&other)

Move constructor from other AttributeParameterValue.



QString AttributeParameterValue::attributeName() const

Returns the name of the attribute that you would like to add a parameter for.

See also setAttributeName().

QString AttributeParameterValue::parameterName() const

Returns the name of the parameter.

See also setParameterName().

QVariant AttributeParameterValue::parameterValue() const

Returns the value of the parameter.

See also setParameterValue().

void AttributeParameterValue::setAttributeName(const QString &attributeName)

Sets the name of the attribute that you would like to add a parameter for to attributeName.

For example, HeightRestriction.

See also attributeName().

void AttributeParameterValue::setParameterName(const QString &parameterName)

Sets the parameter name to parameterName.

For example, Vehicle Height.

See also parameterName().

void AttributeParameterValue::setParameterValue(const QVariant &parameterValue)

Sets the parameter value to parameterValue.

For example, in the case where the parameterName is Vehicle Height, the parameterValue could be 0, meaning the vehicle can fit under any clearance.

See also parameterValue().

AttributeParameterValue &AttributeParameterValue::operator=(const AttributeParameterValue &other)

Assignment operator from other AttributeParameterValue.

AttributeParameterValue &AttributeParameterValue::operator=(AttributeParameterValue &&other)

Move operator from other AttributeParameterValue.

Feedback on this topic?