6

/** YAPF origin provider base class - used when origin is one tile / multiple trackdirs */

    11

	typedef typename Types::Tpf Tpf;              ///< the pathfinder class (derived from THIS class)

    13

	typedef typename Node::Key Key;               ///< key to hash tables

    16

	TileIndex    m_orgTile;                       ///< origin tile

    17

	TrackdirBits m_orgTrackdirs;                  ///< origin trackdir mask

    19

	/// to access inherited path finder

    23

	/// Set origin tile / trackdir mask

    30

	/// Called when YAPF needs to place origin nodes into open list

    42

/** YAPF origin provider base class - used when there are two tile/trackdir origins */

    47

	typedef typename Types::Tpf Tpf;              ///< the pathfinder class (derived from THIS class)

    49

	typedef typename Node::Key Key;               ///< key to hash tables

    52

	TileIndex   m_orgTile;                        ///< first origin tile

    53

	Trackdir    m_orgTd;                          ///< first origin trackdir

    54

	TileIndex   m_revTile;                        ///< second (reversed) origin tile

    55

	Trackdir    m_revTd;                          ///< second (reversed) origin trackdir

    56

	int         m_reverse_penalty;                ///< penalty to be added for using the reversed origin

    57

	bool        m_treat_first_red_two_way_signal_as_eol; ///< in some cases (leaving station) we need to handle first two-way signal differently

    59

	/// to access inherited path finder

    63

	/// set origin (tiles, trackdirs, etc.)

    74

	/// Called when YAPF needs to place origin nodes into open list

    90

	/// return true if first two-way signal should be treated as dead end

    97

/** YAPF destination provider base class - used when destination is single tile / multiple trackdirs */

   102

	typedef typename Types::Tpf Tpf;              ///< the pathfinder class (derived from THIS class)

   104

	typedef typename Node::Key Key;               ///< key to hash tables

   107

	TileIndex    m_destTile;                      ///< destination tile

   108

	TrackdirBits m_destTrackdirs;                 ///< destination trackdir mask

   111

	/// set the destination tile / more trackdirs

   119

	/// to access inherited path finder

   123

	/// Called by YAPF to detect if node ends in the desired destination

   130

	/** Called by YAPF to calculate cost estimate. Calculates distance to the destination

   131

	*   adds it to the actual cost from origin and stores the sum to the Node::m_estimate */

   145

/** YAPF template that uses Ttypes template argument to determine all YAPF

   146

*   components (base classes) from which the actual YAPF is composed.

   147

*   For example classes consult: CYapfRail_TypesT template and its instantiations:

   148

*   CYapfRail1, CYapfRail2, CYapfRail3, CYapfAnyDepotRail1, CYapfAnyDepotRail2, CYapfAnyDepotRail3 */

   151

	: public Ttypes::PfBase         ///< Instance of CYapfBaseT - main YAPF loop and support base class

   152

	, public Ttypes::PfCost         ///< Cost calculation provider base class

   153

	, public Ttypes::PfCache        ///< Segment cost cache provider

   154

	, public Ttypes::PfOrigin       ///< Origin (tile or two-tile origin)

   155

	, public Ttypes::PfDestination  ///< Destination detector and distance (estimate) calculation provider

   156

	, public Ttypes::PfFollow       ///< Node follower (stepping provider)