First_Dev_Dept/ParkingRobot
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document planning visualization library

Browse Source
This commit is contained in:
梁薄云
2026-08-06 09:53:45 +08:00
parent 1ad324ca64
commit 8181f0532f
2 changed files with 65 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ClumsyPilot/tests/TrajectoryPlanningVisualizationVerificationHost/ContractChecks.cs
+21
View File
@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using TrajectoryPlanningVisualization;
@@ -12,6 +13,7 @@ internal static class ContractChecks
CopiesCollectionsAndRejectsNonFiniteNumbers();
StoresOccupancyAsDefensiveCompactBits();
ExposesImmutableSnapshotContracts();
DocumentsPublicSafetyAndLifecycleBoundary();
}
private static void CopiesCollectionsAndRejectsNonFiniteNumbers()
@@ -84,4 +86,23 @@ internal static class ContractChecks
Verification.True(property.SetMethod == null, type.Name + " exposes no property setters");
}
}
private static void DocumentsPublicSafetyAndLifecycleBoundary()
{
string readmePath = Path.GetFullPath(Path.Combine(AppContext.BaseDirectory,
"..", "..", "..", "..", "..", "TrajectoryPlanningVisualization", "README.md"));
string readme = File.ReadAllText(readmePath);
Verification.True(readme.Contains("OBSERVE_ONLY"), "README documents observe-only boundary");
Verification.True(readme.Contains("127.0.0.1"), "README documents loopback boundary");
Verification.True(readme.Contains("capacity 1"), "README documents latest-frame capacity");
Verification.True(readme.Contains("60"), "README documents default history limit");
Verification.True(readme.Contains("10 Hz"), "README documents default refresh rate");
Verification.True(readme.Contains("j[i]"), "README documents jerk interval semantics");
Verification.True(readme.Contains("末点后无时间区间"), "README documents jerk terminal explanation");
Verification.True(readme.Contains("PlanningVisualizationSessionInfo info = visualization.Start(staticSnapshot);"),
"README documents Start example");
Verification.True(readme.Contains("visualization.Publish(dynamicSnapshot);"), "README documents Publish example");
Verification.True(readme.Contains("visualization.Stop();"), "README documents Stop example");
}
}