| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Security.Cryptography; |
| | | 4 | | |
| | | 5 | | namespace Itinero.Profiles; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Abstract representation of a profile. |
| | | 9 | | /// </summary> |
| | | 10 | | /// <remarks> |
| | | 11 | | /// This is a single possible behaviour of a vehicle (e.g. 'bicycle.fastest'). |
| | | 12 | | /// </remarks> |
| | | 13 | | public abstract class Profile |
| | | 14 | | { |
| | | 15 | | /// <summary> |
| | | 16 | | /// Gets the name of this profile. |
| | | 17 | | /// </summary> |
| | | 18 | | public abstract string Name { get; } |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Gets the edge factor for the given attributes. |
| | | 22 | | /// </summary> |
| | | 23 | | /// <param name="attributes">The attributes.</param> |
| | | 24 | | /// <returns>An edge factor.</returns> |
| | | 25 | | public abstract EdgeFactor Factor(IEnumerable<(string key, string value)> attributes); |
| | | 26 | | |
| | | 27 | | /// <summary> |
| | | 28 | | /// Gets a factor for the turn costs for the given attributes. |
| | | 29 | | /// </summary> |
| | | 30 | | /// <param name="attributes">The attributes.</param> |
| | | 31 | | /// <returns>A turn cost factor.</returns> |
| | | 32 | | public abstract TurnCostFactor TurnCostFactor(IEnumerable<(string key, string value)> attributes); |
| | | 33 | | |
| | | 34 | | /// <summary> |
| | | 35 | | /// Gets whether turn cost factors are enabled for this profile. |
| | | 36 | | /// When true, edge-based routing is used to properly handle turn restrictions. |
| | | 37 | | /// </summary> |
| | 57 | 38 | | public virtual bool TurnCostFactorEnabled => false; |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Gets a stable hashcode, this hashcode doesn't change between runs. |
| | | 42 | | /// </summary> |
| | | 43 | | /// <remarks> |
| | | 44 | | /// This uses the name property by default, if using profiles with unique names this default implementation is fine. |
| | | 45 | | /// </remarks> |
| | | 46 | | /// <returns>The stable hash code.</returns> |
| | | 47 | | public override int GetHashCode() |
| | 0 | 48 | | { |
| | | 49 | | // TODO: a slow hash, this can be better. |
| | | 50 | | // on the other hand this hash should only be computed once when the profile is added to a router db. |
| | 0 | 51 | | var hash = Hasher.ComputeHash(System.Text.Encoding.Default.GetBytes(this.Name)); |
| | 0 | 52 | | return BitConverter.ToInt32(hash, 0); |
| | 0 | 53 | | } |
| | | 54 | | |
| | | 55 | | /// <summary> |
| | | 56 | | /// Compares this profiles to the given profile. Returns true if the profiles are identical functionally. |
| | | 57 | | /// </summary> |
| | | 58 | | /// <remarks> |
| | | 59 | | /// This uses the name property by default, if using profiles with unique names this default implementation is fine. |
| | | 60 | | /// </remarks> |
| | | 61 | | /// <returns>True if the profiles have the same name.</returns> |
| | | 62 | | public override bool Equals(object obj) |
| | 0 | 63 | | { |
| | 0 | 64 | | if (obj is Profile profile) |
| | 0 | 65 | | { |
| | 0 | 66 | | return profile.Name.Equals(this.Name); |
| | | 67 | | } |
| | | 68 | | |
| | 0 | 69 | | return false; |
| | 0 | 70 | | } |
| | | 71 | | |
| | 0 | 72 | | private static readonly MD5 Hasher = MD5.Create(); |
| | | 73 | | } |