add note about order

Signed-off-by: Ian Chen <[email protected]>
gazebosim · Sep 4, 2020 · 359ca9a · 359ca9a
1 parent 012156e
commit 359ca9a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tpe/lib/src/Model.cc b/tpe/lib/src/Model.cc
@@ -94,6 +94,9 @@ Entity &Model::GetCanonicalLink()
   if (linkEnt.GetId() != kNullEntityId)
     return linkEnt;
 
+  // todo(anyone) the code below does not guarantee that the link returned is
+  // the first link defined in SDF since GetChildren returns a std::map, and
+  // likewise the use of std::set, do not preserve order.
   std::set<Model *> models;
   for (auto &it : this->GetChildren())
   {