yapf_type.hpp File Reference

Types used by YAPF. More...

#include "../../core/enum_type.hpp"
#include "../../misc/dbg_helpers.h"

Go to the source code of this file.

Typedefs
using	EndSegmentReasons = EnumBitSet<EndSegmentReason, uint16_t>

Enumerations
enum class	EndSegmentReason : uint8_t {   DeadEnd , RailType , InfiniteLoop , SegmentTooLong ,   ChoiceFollows , Depot , Waypoint , Station ,   SafeTile , PathTooLong , FirstTwoWayRed , LookAheadEnd ,   TargetReached }
	Enum used in PfCalcCost() to see why was the segment closed. More...

Functions
std::string	ValueStr (EndSegmentReasons flags)

Variables
static constexpr EndSegmentReasons	ESRF_POSSIBLE_TARGET
	What reasons mean that the target can be found and needs to be detected.
static constexpr EndSegmentReasons	ESRF_CACHED_MASK
	What reasons can be stored back into cached segment.
static constexpr EndSegmentReasons	ESRF_ABORT_PF_MASK
	Reasons to abort pathfinding in this direction.

Detailed Description

Types used by YAPF.

Definition in file yapf_type.hpp.

Typedef Documentation

EndSegmentReasons

using EndSegmentReasons = EnumBitSet<EndSegmentReason, uint16_t>

Definition at line 36 of file yapf_type.hpp.

Enumeration Type Documentation

EndSegmentReason

enum class EndSegmentReason : uint8_t

strong

Enum used in PfCalcCost() to see why was the segment closed.

Enumerator
DeadEnd	track ends here
RailType	the next tile has a different rail type than our tiles
InfiniteLoop	infinite loop detected
SegmentTooLong	the segment is too long (possible infinite loop)
ChoiceFollows	the next tile contains a choice (the track splits to more than one segments)
Depot	stop in the depot (could be a target next time)
Waypoint	waypoint encountered (could be a target next time)
Station	station encountered (could be a target next time)
SafeTile	safe waiting position found (could be a target)
PathTooLong	the path is too long (searching for the nearest depot in the given radius)
FirstTwoWayRed	first signal was 2-way and it was red
LookAheadEnd	we have just passed the last look-ahead signal
TargetReached	we have just reached the destination

Definition at line 17 of file yapf_type.hpp.

Function Documentation

ValueStr()

std::string ValueStr ( EndSegmentReasons flags )

inline

Definition at line 67 of file yapf_type.hpp.

Variable Documentation

ESRF_ABORT_PF_MASK

EndSegmentReasons ESRF_ABORT_PF_MASK

staticconstexpr

Initial value:

                                                      = {
  EndSegmentReason::DeadEnd,
  EndSegmentReason::PathTooLong,
  EndSegmentReason::InfiniteLoop,
  EndSegmentReason::FirstTwoWayRed,
}

Reasons to abort pathfinding in this direction.

Definition at line 60 of file yapf_type.hpp.

Referenced by CYapfCostRailT< Types >::PfCalcCost().

ESRF_CACHED_MASK

EndSegmentReasons ESRF_CACHED_MASK

staticconstexpr

Initial value:

                                                    = {
  EndSegmentReason::DeadEnd,
  EndSegmentReason::RailType,
  EndSegmentReason::InfiniteLoop,
  EndSegmentReason::SegmentTooLong,
  EndSegmentReason::ChoiceFollows,
  EndSegmentReason::Depot,
  EndSegmentReason::Waypoint,
  EndSegmentReason::Station,
  EndSegmentReason::SafeTile,
}

What reasons can be stored back into cached segment.

Definition at line 47 of file yapf_type.hpp.

Referenced by CYapfCostRailT< Types >::PfCalcCost().

ESRF_POSSIBLE_TARGET

EndSegmentReasons ESRF_POSSIBLE_TARGET

staticconstexpr

Initial value:

                                                        = {
  EndSegmentReason::Depot,
  EndSegmentReason::Waypoint,
  EndSegmentReason::Station,
  EndSegmentReason::SafeTile,
}

What reasons mean that the target can be found and needs to be detected.

Definition at line 39 of file yapf_type.hpp.

Referenced by CYapfCostRailT< Types >::PfCalcCost().