PolylineBarrier Class

  • PolylineBarrier
  • class Esri::ArcGISRuntime::PolylineBarrier

    A polyline barrier is used to restrict route solving. More...

    Header: #include <PolylineBarrier.h>
    Since: Esri::ArcGISRuntime 100.0

    Public Functions

    PolylineBarrier(const Esri::ArcGISRuntime::Polyline &polyline)
    PolylineBarrier(const Esri::ArcGISRuntime::PolylineBarrier &other)
    PolylineBarrier(Esri::ArcGISRuntime::PolylineBarrier &&other)
    int barrierId() const
    Esri::ArcGISRuntime::BarrierType barrierType() const
    Esri::ArcGISRuntime::PolylineBarrier clone() const
    Esri::ArcGISRuntime::Polyline geometry() const
    bool isEmpty() const
    QString name() const
    double scaleFactorForCost(const QString &attributeName) const
    void setBarrierId(int id)
    void setBarrierType(Esri::ArcGISRuntime::BarrierType type)
    void setGeometry(const Esri::ArcGISRuntime::Polyline &polyline)
    void setName(const QString &name)
    void setScaleFactorForCost(const QString &attributeName, double scaleFactorForCost)
    Esri::ArcGISRuntime::PolylineBarrier &operator=(const Esri::ArcGISRuntime::PolylineBarrier &other)
    Esri::ArcGISRuntime::PolylineBarrier &operator=(Esri::ArcGISRuntime::PolylineBarrier &&other)

    Detailed Description

    A class that represents a linear feature to be avoided (or penalized) by a route. A polyline barrier may represent a linear feature (e.g., a subpath in the network) to be avoided (i.e., not crossed or followed) by a route or to penalize/delay a route along any portions of the feature traversed by the route (e.g., a stretch of interstate with temporarily reduced speed limits due to local construction along an adjacent lane).

    The polyline barrier class is derived from the graphic class.

    Member Function Documentation


    Default constructor.

    [explicit] PolylineBarrier::PolylineBarrier(const Esri::ArcGISRuntime::Polyline &polyline)

    Constructor that takes in a polyline.

    PolylineBarrier::PolylineBarrier(const Esri::ArcGISRuntime::PolylineBarrier &other)

    Copy constructor from other PolylineBarrier.

    PolylineBarrier::PolylineBarrier(Esri::ArcGISRuntime::PolylineBarrier &&other)

    Move constructor from other PolylineBarrier.



    [since Esri::ArcGISRuntime 100.6] int PolylineBarrier::barrierId() const

    Returns polyline barrier ID.

    This is a caller supplied foreign key that can be used to associate output polyline barriers with input polyline barriers.

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also setBarrierId(), RouteParameters::setPolylineBarriers, RouteResult::polylineBarriers, ClosestFacilityParameters::setPolylineBarriers, ClosestFacilityResult::polylineBarriers, ServiceAreaParameters::setPolylineBarriers, and ServiceAreaResult::polylineBarriers.

    Esri::ArcGISRuntime::BarrierType PolylineBarrier::barrierType() const

    Returns the BarrierType of this PolylineBarrier.

    See also setBarrierType().

    [since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::PolylineBarrier PolylineBarrier::clone() const

    Clones the PolylineBarrier to a new instance.

    Returns a new instance of the current PolylineBarrier.

    This function was introduced in Esri::ArcGISRuntime 200.1.

    Esri::ArcGISRuntime::Polyline PolylineBarrier::geometry() const

    Returns the Polyline of this PolylineBarrier.

    See also setGeometry().

    bool PolylineBarrier::isEmpty() const

    Returns true if this PolylineBarrier is empty.

    [since Esri::ArcGISRuntime 100.3] QString PolylineBarrier::name() const

    Returns the name of this PolylineBarrier.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    See also setName().

    double PolylineBarrier::scaleFactorForCost(const QString &attributeName) const

    Returns scale factor for cost of a given attributeName.

    See also setScaleFactorForCost().

    [since Esri::ArcGISRuntime 100.6] void PolylineBarrier::setBarrierId(int id)

    Sets the id of this barrier.

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also barrierId.

    void PolylineBarrier::setBarrierType(Esri::ArcGISRuntime::BarrierType type)

    Sets the type of this PolylineBarrier.

    See also barrierType.

    void PolylineBarrier::setGeometry(const Esri::ArcGISRuntime::Polyline &polyline)

    Sets the polyline of this PolylineBarrier.

    See also geometry.

    [since Esri::ArcGISRuntime 100.3] void PolylineBarrier::setName(const QString &name)

    Sets the name of this PolylineBarrier.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    See also name.

    void PolylineBarrier::setScaleFactorForCost(const QString &attributeName, double scaleFactorForCost)

    Sets the added cost (scaleFactorForCost) for a given attributeName.

    See also scaleFactorForCost().

    Esri::ArcGISRuntime::PolylineBarrier &PolylineBarrier::operator=(const Esri::ArcGISRuntime::PolylineBarrier &other)

    Assignment operator from other PolylineBarrier.

    Esri::ArcGISRuntime::PolylineBarrier &PolylineBarrier::operator=(Esri::ArcGISRuntime::PolylineBarrier &&other)

    Move operator from other PolylineBarrier.

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