GNECandidateElement.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// class for candidate elements
/****************************************************************************/
#pragma once
#include <config.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNECandidateElement {
 
public:
    GNECandidateElement();
 
    ~GNECandidateElement();
 
    void resetCandidateFlags();
 
    bool isPossibleCandidate() const;
 
    bool isSourceCandidate() const;
 
    bool isTargetCandidate() const;
 
    bool isSpecialCandidate() const;
 
    bool isConflictedCandidate() const;
 
    bool isInvalidCandidate() const;
 
    void setPossibleCandidate(const bool value);
 
    void setSourceCandidate(const bool value);
 
    void setTargetCandidate(const bool value);
 
    void setSpecialCandidate(const bool value);
 
    void setConflictedCandidate(const bool value);
 
    void setInvalidCandidate(const bool value);
 
 
    double getReachability() const;
 
    void setReachability(const double reachability);
 
    void resetReachability();
 
 
protected:
    bool myPossibleCandidate = false;
 
    bool mySourceCandidate = false;
 
    bool myTargetCandidate = false;
 
    bool mySpecialCandidate = false;
 
    bool myConflictedCandidate = false;
 
    bool myInvalidCandidate = false;
 
    double myReachability = -1;
 
private:
    GNECandidateElement(const GNECandidateElement&) = delete;
 
    GNECandidateElement& operator=(const GNECandidateElement& src) = delete;
};