PointBarrier Class

  • PointBarrier
  • class Esri::ArcGISRuntime::PointBarrier

    A point barrier object is used to restrict route solving. More...

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

    Public Functions

    PointBarrier(const Esri::ArcGISRuntime::Point &point)
    PointBarrier(const Esri::ArcGISRuntime::PointBarrier &other)
    PointBarrier(Esri::ArcGISRuntime::PointBarrier &&other)
    double addedCost(const QString &attributeName) const
    int barrierId() const
    Esri::ArcGISRuntime::BarrierType barrierType() const
    Esri::ArcGISRuntime::PointBarrier clone() const
    Esri::ArcGISRuntime::CurbApproach curbApproach() const
    Esri::ArcGISRuntime::Point geometry() const
    bool isEmpty() const
    Esri::ArcGISRuntime::LocationStatus locationStatus() const
    QString name() const
    void setAddedCost(const QString &attributeName, double addedCost)
    void setBarrierId(int id)
    void setBarrierType(Esri::ArcGISRuntime::BarrierType type)
    void setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)
    void setGeometry(const Esri::ArcGISRuntime::Point &point)
    void setName(const QString &name)
    Esri::ArcGISRuntime::PointBarrier &operator=(const Esri::ArcGISRuntime::PointBarrier &other)
    Esri::ArcGISRuntime::PointBarrier &operator=(Esri::ArcGISRuntime::PointBarrier &&other)

    Detailed Description

    A class that represents a point location to be avoided (or penalized) by a route. A point barrier may represent a restricted location to be avoided by a route (e.g., a car accident) or a location at which some additional delay occurs if visited along a route (e.g., a railroad crossing).

    The point barrier class is derived from the graphic class.

    Member Function Documentation


    Default constructor.

    [explicit] PointBarrier::PointBarrier(const Esri::ArcGISRuntime::Point &point)

    Constructor that takes in a point.

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

    Copy constructor from other PointBarrier.

    PointBarrier::PointBarrier(Esri::ArcGISRuntime::PointBarrier &&other)

    Move constructor from other PointBarrier.



    double PointBarrier::addedCost(const QString &attributeName) const

    Returns the added cost.

    • attributeName - The name of attribute.

    Get the amount of additional cost that has been added for a particular attribute on this Stop. If no cost has been added, or an incorrect name is specified, a value of zero will be returned.

    See also setAddedCost().

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

    Returns point barrier ID.

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

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also setBarrierId(), RouteParameters::setPointBarriers, RouteResult::pointBarriers, ClosestFacilityParameters::setPointBarriers, ClosestFacilityResult::pointBarriers, ServiceAreaParameters::setPointBarriers, and ServiceAreaResult::pointBarriers.

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

    Returns the BarrierType of this PointBarrier.

    See also setBarrierType().

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

    Clones the PointBarrier to a new instance.

    Returns a new instance of the current PointBarrier.

    This function was introduced in Esri::ArcGISRuntime 200.1.

    Esri::ArcGISRuntime::CurbApproach PointBarrier::curbApproach() const

    Returns the CurbApproach of this PointBarrier.

    See also setCurbApproach().

    Esri::ArcGISRuntime::Point PointBarrier::geometry() const

    Returns the Point of this PointBarrier.

    See also setGeometry().

    bool PointBarrier::isEmpty() const

    Returns true if this PointBarrier is empty.

    Esri::ArcGISRuntime::LocationStatus PointBarrier::locationStatus() const

    Returns the LocationStatus of this PointBarrier.

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

    Returns the name of this PointBarrier.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    See also setName().

    void PointBarrier::setAddedCost(const QString &attributeName, double addedCost)

    Sets the added cost.

    • attributeName - The name of attribute.
    • addedCost - The added cost.

    Set the amount of additional cost for an attribute by name. Any additional cost, e.g. Minutes, TravelTime, Kilometers, can be modified with this method.

    See also addedCost().

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

    Sets the id of this barrier.

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also barrierId.

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

    Returns the barrier type of this PointBarrier.

    See also barrierType.

    void PointBarrier::setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)

    Sets the curbApproach of this PointBarrier.

    See also curbApproach.

    void PointBarrier::setGeometry(const Esri::ArcGISRuntime::Point &point)

    Sets the point of this PointBarrier.

    See also geometry.

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

    Sets the name of this PointBarrier.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    See also name.

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

    Assignment operator from other PointBarrier.

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

    Move operator from other PointBarrier.

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