DatasetAccessor.GetGmlFiles 利便性向上 (Synesthesias#151)

linoal · web-flow · commit 829fae78b8df · 2023-03-09T15:31:36.000+09:00
* DatasetAccessor.GetGmlFilesを実装

* 同上

* LocalDatasetAccessor::getGmlFiles() と ServerDatasetAccessor::getGmlFiles() の引数のパッケージを複数指定に対応。そのテストを記述。

* テスト微修正

* サーバーからのjsonで featureTypes : null が含まれても動作するようにしました
diff --git a/data/日本語パステスト/udx/tran/533925_tran_6697_op.gml b/data/日本語パステスト/udx/tran/533925_tran_6697_op.gml
diff --git a/include/plateau/dataset/i_dataset_accessor.h b/include/plateau/dataset/i_dataset_accessor.h
@@ -66,6 +66,7 @@ namespace plateau::dataset {
     public:
         /**
          * \brief GMLファイル群のうち、範囲が extent の内部であり、パッケージ種が package であるものを vector で返します。
+         * なお、 package はフラグの集合と見なされるので、複数のビットを立てることで複数の指定が可能です。
          */
          virtual std::shared_ptr<std::vector<GmlFile>> getGmlFiles(const PredefinedCityModelPackage package) = 0;
 
diff --git a/src/c_wrapper/vector_c.cpp b/src/c_wrapper/vector_c.cpp
@@ -8,14 +8,15 @@ extern "C"{
     using namespace plateau::network;
 
 /**
- * vector<任意の型> を P/Invoke で扱うための6つのメソッドを生成するマクロです。
- * 6つのメソッドとは
+ * vector<任意の型> を P/Invoke で扱うための7つのメソッドを生成するマクロです。
+ * そのメソッドとは
  * 1: plateau_create_vector_FUNC_NAME (new)
  * 2: plateau_delete_vector_FUNC_NAME (delete),
  * 3: plateau_vector_FUNC_NAME_get_pointer (要素のポインタを取得),
  * 4: plateau_vector_FUNC_NAME_get_value (要素の値を取得)
  * 5: plateau_vector_FUNC_NAME_count (要素数を取得)
- * 6: plateau_vector_FUNC_NAME_push_back_value (値渡しで要素を追加)
+ * 6: plateau_vector_FUNC_NAME_push_back_value (要素を追加, 値渡し)
+ * 7: plateau_vector_FUNC_NAME_push_back_copy_of_ref (要素を追加, ポインタ渡しでポインタの参照先のコピーを追加)
  * です。
  * なお通常は、 3か4のどちらか片方は利用しないはずです。
  * vectorの要素は実体で保持されます。
@@ -56,7 +57,12 @@ LIBPLATEAU_C_EXPORT APIResult LIBPLATEAU_API plateau_create_vector_ ## FUNC_NAME
     DLL_2_ARG_FUNC (plateau_vector_ ## FUNC_NAME ## _push_back_value,\
         std::vector< VECTOR_ELEMENT_TYPE >* const vector, \
         VECTOR_ELEMENT_TYPE element, \
-        vector->push_back(element))
+        vector->push_back(element))                    \
+                                                       \
+    DLL_2_ARG_FUNC(plateau_vector_ ## FUNC_NAME ## _push_back_copy_of_ref, \
+        std::vector< VECTOR_ELEMENT_TYPE >* const vector, \
+        VECTOR_ELEMENT_TYPE* element_ptr, /*NOLINT*/ \
+        vector->push_back(*element_ptr))
 
     PLATEAU_VECTOR(gml_file, GmlFile)
     PLATEAU_VECTOR(mesh_code, MeshCode)
diff --git a/src/dataset/local_dataset_accessor.cpp b/src/dataset/local_dataset_accessor.cpp
@@ -185,14 +185,27 @@ namespace plateau::dataset {
         return result;
     }
 
-    void LocalDatasetAccessor::getGmlFiles(PredefinedCityModelPackage package, std::vector<GmlFile>& gml_files) {
-        if (files_.find(package) == files_.end())
-            return;
-
-        for (const auto& file : files_[package]) {
-            if(!file.isValid()) continue;
-            gml_files.push_back(file);
+    void LocalDatasetAccessor::getGmlFiles(PredefinedCityModelPackage package_flags, std::vector<GmlFile>& gml_files) {
+        auto package_num = static_cast<std::underlying_type<PredefinedCityModelPackage>::type>(package_flags);
+        int i = 0;
+        while(package_num > 0){
+            if((package_num & 1) == 1){
+                // フラグが立っている各パッケージについて
+                auto package = (PredefinedCityModelPackage)(1 << i);
+                if (files_.find(package) != files_.end()){
+                    // そのパッケージのファイルが存在すれば追加します。
+                    for (const auto& file : files_[package]) {
+                        if(file.isValid()){
+                            gml_files.push_back(file);
+                        }
+                    }
+                }
+            }
+            ++i;
+            package_num >>= 1;
         }
+
+
     }
 
     std::string LocalDatasetAccessor::getU8RelativePath(const std::string& path) const {
diff --git a/src/dataset/local_dataset_accessor.h b/src/dataset/local_dataset_accessor.h
@@ -54,10 +54,10 @@ namespace plateau::dataset {
         /**
          * \brief packageに該当するCityGMLファイルを取得します。
          *        なければ空のvectorを返します。
-         * \param package 都市モデルパッケージ
+         * \param package_flags 都市モデルパッケージ
          * \param gml_files 取得結果の格納先
          */
-        void getGmlFiles(PredefinedCityModelPackage package, std::vector<GmlFile>& gml_files) override;
+        void getGmlFiles(PredefinedCityModelPackage package_flags, std::vector<GmlFile>& gml_files) override;
 
         /**
          * \brief packageに該当するCityGMLファイルの個数を取得します。
diff --git a/src/dataset/server_dataset_accessor.cpp b/src/dataset/server_dataset_accessor.cpp
@@ -38,11 +38,13 @@ namespace plateau::dataset {
     }
 
     void ServerDatasetAccessor::getGmlFiles(
-        const PredefinedCityModelPackage package,
+        const PredefinedCityModelPackage package_flags,
         std::vector<GmlFile>& out_gml_files) {
 
+        auto arg_package_num = static_cast<std::underlying_type<PredefinedCityModelPackage>::type>(package_flags);
         for (const auto& [sub_folder, gml_files] : dataset_files_) {
-            if (UdxSubFolder::getPackage(sub_folder) == package) {
+            auto data_package_num = static_cast<std::underlying_type<PredefinedCityModelPackage>::type>(UdxSubFolder::getPackage(sub_folder));
+            if ((data_package_num & arg_package_num) != 0) { // フラグ群の積集合が1つ以上あるなら、引数の package のどれかに合致するので追加
                 for (const auto& dataset_file : gml_files) {
                     out_gml_files.emplace_back(dataset_file.url, client_, dataset_file.max_lod);
                 }
diff --git a/src/dataset/server_dataset_accessor.h b/src/dataset/server_dataset_accessor.h
@@ -20,7 +20,7 @@ namespace plateau::dataset {
 
         std::set<MeshCode>& getMeshCodes() override;
         std::shared_ptr<std::vector<GmlFile>> getGmlFiles(const PredefinedCityModelPackage package) override;
-        void getGmlFiles(const PredefinedCityModelPackage package, std::vector<GmlFile>& out_gml_files) override;
+        void getGmlFiles(const PredefinedCityModelPackage package_flags, std::vector<GmlFile>& out_gml_files) override;
 
         TVec3d calculateCenterPoint(const plateau::geometry::GeoReference& geo_reference) override;
         
diff --git a/src/network/client.cpp b/src/network/client.cpp
@@ -78,7 +78,11 @@ namespace plateau::network {
                     dataset_metadata.title = json_dataset_metadata.at("title");
                     dataset_metadata.description = json_dataset_metadata.at("description");
                     if (json_dataset_metadata.contains("featureTypes")) {
-                        dataset_metadata.feature_types = json_dataset_metadata.at("featureTypes");
+                        auto json_feature_types = json_dataset_metadata.at("featureTypes");
+                        if(json_feature_types.is_array()) { // featureTypes : null の場合を除外
+                            dataset_metadata.feature_types = json_feature_types;
+                        }
+
                     }
                     dataset_metadata_group.datasets.push_back(dataset_metadata);
                 }
diff --git a/test/test_dataset.cpp b/test/test_dataset.cpp
@@ -41,21 +41,40 @@ class DatasetTest : public ::testing::Test {
     std::shared_ptr<IDatasetAccessor> local_dataset_accessor;
 };
 
-TEST_F(DatasetTest, getAllGmls) { // NOLINT
-    const std::vector expected_bldg_files =
-    { std::filesystem::u8path(u8"../data/日本語パステスト/udx/bldg/53392642_bldg_6697_op2.gml").make_preferred().u8string() };
+TEST_F(DatasetTest, getGmlsLocal) { // NOLINT
+    const std::vector expected_files =
+    { std::filesystem::u8path(u8"../data/日本語パステスト/udx/bldg/53392642_bldg_6697_op2.gml").make_preferred().u8string(),
+      std::filesystem::u8path( u8"../data/日本語パステスト/udx/tran/533925_tran_6697_op.gml").make_preferred().u8string() };
     std::vector<std::string> actual_files;
-    const auto gml_files = local_dataset_accessor->getGmlFiles(PredefinedCityModelPackage::Building);
+    auto packages = PredefinedCityModelPackage::Building | PredefinedCityModelPackage::Road;
+    const auto gml_files = local_dataset_accessor->getGmlFiles(packages);
     for (const auto& gml_file : *gml_files) {
         actual_files.push_back(gml_file.getPath());
     }
+    checkVectors(expected_files, actual_files);
+}
 
-    checkVectors(expected_bldg_files, actual_files);
+TEST_F(DatasetTest, getGmlsServer) { // NOLINT
+    const auto source = DatasetSource::createServer("23ku", Client::createClientForMockServer());
+    const auto accessor = source.getAccessor();
+    const auto gml_files = accessor->getGmlFiles(PredefinedCityModelPackage::Building | PredefinedCityModelPackage::LandUse);
+    auto actual_gml_files = std::vector<std::string>();
+    for(const auto& gml_file : *gml_files){
+        actual_gml_files.push_back(gml_file.getPath());
+    }
+    const std::vector<std::string> expected_files = {
+            u8"https://plateau-api-mock-v2.deta.dev/13100_tokyo23-ku_2020_citygml_3_2_op/udx/bldg/53392642_bldg_6697_2_op.gml",
+            u8"https://plateau-api-mock-v2.deta.dev/13100_tokyo23-ku_2020_citygml_3_2_op/udx/bldg/53392670_bldg_6697_2_op.gml",
+            u8"https://plateau-api-mock-v2.deta.dev/13100_tokyo23-ku_2020_citygml_3_2_op/udx/luse/533926_luse_6668_2_op.gml",
+            u8"https://plateau-api-mock-v2.deta.dev/13100_tokyo23-ku_2020_citygml_3_2_op/udx/luse/533926_luse_6668_2_op.gml",
+            u8"https://plateau-api-mock-v2.deta.dev/13100_tokyo23-ku_2020_citygml_3_2_op/udx/luse/533926_luse_6697_park_op.gml"
+    };
+    checkVectors(expected_files, actual_gml_files);
 }
 
 TEST_F(DatasetTest, getAllMeshCodes) { // NOLINT
     const auto& mesh_codes = local_dataset_accessor->getMeshCodes();
-    ASSERT_EQ(mesh_codes.size(), 1);
+    ASSERT_TRUE(mesh_codes.size() > 0);
 }
 
 namespace {
diff --git a/test/test_dataset_source.cpp b/test/test_dataset_source.cpp
@@ -19,7 +19,7 @@ namespace plateau::dataset {
                         std::move(DatasetSource::createLocal(u8"../data/日本語パステスト")));
         auto accessor = source->getAccessor();
         auto mesh_code_str = accessor->getMeshCodes().begin()->get();
-        ASSERT_EQ(mesh_code_str, "53392642");
+        ASSERT_EQ(mesh_code_str, "533925");
     }
 
     TEST_F(DatasetSourceTest, get_accessor_of_server_source_returns_server_accessor) { // NOLINT
diff --git a/test/test_network_client.cpp b/test/test_network_client.cpp
@@ -48,7 +48,7 @@ namespace plateau::network {
 
     TEST_F(ClientTest, DownloadFilesOfDefaultServer) { // NOLINT
         auto client = Client("", "");
-        auto first_id = client.getMetadata()->at(0).datasets.at(0).id;
+        auto first_id = client.getMetadata()->at(1).datasets.at(0).id;
         auto files = client.getFiles(first_id);
         ASSERT_TRUE(!files.empty()) << "Dataset files is not empty.";
         auto files_of_first_package = files.begin()->second;
diff --git a/wrappers/csharp/LibPLATEAU.NET/CSharpPLATEAU.Test/Dataset/DatasetAccessorTest.cs b/wrappers/csharp/LibPLATEAU.NET/CSharpPLATEAU.Test/Dataset/DatasetAccessorTest.cs
@@ -13,19 +13,22 @@ namespace PLATEAU.Test.Dataset
     public class DatasetAccessorTest
     {
 
+        private const string TestDataPathLocal = "data/日本語パステスト";
+        private const string TestDatasetIdServer = "23ku"; // モックサーバーに置かれた東京23区のデータセットID
+
         [TestMethod]
         public void GetMeshCodesLocal()
         {
-            using var source = DatasetSource.CreateLocal("data/日本語パステスト");
+            using var source = DatasetSource.CreateLocal(TestDataPathLocal);
             using var accessor = source.Accessor;
-            Assert.AreEqual(1, accessor.MeshCodes.Length);
+            Assert.IsTrue(accessor.MeshCodes.Length > 0, "メッシュコードが存在します。");
             Console.WriteLine(accessor.MeshCodes.At(0).ToString());
         }
 
         [TestMethod]
         public void GetMeshCodeServer()
         {
-            using var source = DatasetSource.CreateForMockServer("23ku");
+            using var source = DatasetSource.CreateForMockServer(TestDatasetIdServer);
             using var accessor = source.Accessor;
             var meshCodes = accessor.MeshCodes;
             Assert.AreEqual(2, meshCodes.Length);
@@ -35,7 +38,7 @@ public void GetMeshCodeServer()
         [TestMethod]
         public void GetGmlFilesLocal()
         {
-            using var datasetSource = DatasetSource.CreateLocal("data/日本語パステスト");
+            using var datasetSource = DatasetSource.CreateLocal(TestDataPathLocal);
             using var accessor = datasetSource.Accessor;
             var gmls = accessor.GetGmlFiles(PredefinedCityModelPackage.Building);
             Assert.AreEqual(1, gmls.Length);
@@ -49,7 +52,7 @@ public void GetGmlFilesLocal()
         [TestMethod]
         public void GetGmlFilesServer()
         {
-            using var source = DatasetSource.CreateForMockServer("23ku");
+            using var source = DatasetSource.CreateForMockServer(TestDatasetIdServer);
             using var accessor = source.Accessor;
             var gmlFiles = accessor.GetGmlFiles(PredefinedCityModelPackage.Building);
             Assert.AreEqual(2, gmlFiles.Length);
@@ -60,17 +63,17 @@ public void GetGmlFilesServer()
         [TestMethod]
         public void GetPackagesLocal()
         {
-            using var datasetSource = DatasetSource.CreateLocal("data/日本語パステスト");
+            using var datasetSource = DatasetSource.CreateLocal(TestDataPathLocal);
             using var accessor = datasetSource.Accessor;
             Console.WriteLine(Path.GetFullPath(accessor.GetGmlFiles(PredefinedCityModelPackage.Building).At(0).Path));
-            var expected = PredefinedCityModelPackage.Building;
+            var expected = PredefinedCityModelPackage.Building | PredefinedCityModelPackage.Road;
             Assert.AreEqual(expected, accessor.Packages);
         }
         
         [TestMethod]
         public void GetPackagesServer()
         {
-            using var source = DatasetSource.CreateForMockServer("23ku");
+            using var source = DatasetSource.CreateForMockServer(TestDatasetIdServer);
             using var accessor = source.Accessor;
             var buildings = accessor.GetGmlFiles(PredefinedCityModelPackage.Building);
             Assert.AreEqual(2, buildings.Length);
@@ -81,42 +84,42 @@ public void GetPackagesServer()
         [TestMethod]
         public void CalcCenterLocal()
         {
-            using var source = DatasetSource.CreateLocal("data/日本語パステスト");
+            using var source = DatasetSource.CreateLocal(TestDataPathLocal);
             TestCenterPoint(source);
         }
 
         [TestMethod]
         public void CalcCenterPointServer()
         {
-            using var source = DatasetSource.CreateForMockServer("23ku");
+            using var source = DatasetSource.CreateForMockServer(TestDatasetIdServer);
             TestCenterPoint(source);
         }
 
         [TestMethod]
         public void MaxLodLocal()
         {
-            using var datasetSource = DatasetSource.CreateLocal("data/日本語パステスト");
-            using var accessor = datasetSource.Accessor;
+            using var datasetSource = DatasetSource.CreateLocal(TestDataPathLocal);
+            var accessor = datasetSource.Accessor;
             var meshCodes = accessor.MeshCodes;
-            Assert.AreEqual(1, meshCodes.Length);
+            Assert.IsTrue(meshCodes.Length > 0, "メッシュコードが存在します。");
             int maxLod = accessor.GetGmlFiles(PredefinedCityModelPackage.Building).At(0).GetMaxLod();
             Assert.AreEqual(2, maxLod);
         }
         
         [TestMethod]
         public void MaxLodServer()
         {
-            using var source = DatasetSource.CreateForMockServer("23ku");
-            using var accessor = source.Accessor;
+            using var source = DatasetSource.CreateForMockServer(TestDatasetIdServer);
+            var accessor = source.Accessor;
             var gmls = accessor.GetGmlFiles(PredefinedCityModelPackage.Building);
             Assert.AreEqual(2, gmls.At(1).GetMaxLod());
         }
         
         [TestMethod]
         public void FilterByMeshCodes_Contains_MeshCode_Only_If_Valid_Local()
         {
-            using var source = DatasetSource.CreateLocal("data/日本語パステスト");
-            using var accessor = source.Accessor;
+            using var source = DatasetSource.CreateLocal(TestDataPathLocal);
+            var accessor = source.Accessor;
             string validMeshCode = "53392642";
             string invalidMeshCode = "99999999";
             Assert.IsTrue(DoResultOfFilterByMeshCodesContainsMeshCode(accessor, validMeshCode));
@@ -126,14 +129,26 @@ public void FilterByMeshCodes_Contains_MeshCode_Only_If_Valid_Local()
         [TestMethod]
         public void FilterByMeshCodes_Contains_MeshCode_Only_If_Valid_Server()
         {
-            using var source = DatasetSource.CreateForMockServer("23ku");
-            using var accessor = source.Accessor;
+            using var source = DatasetSource.CreateForMockServer(TestDatasetIdServer);
+            var accessor = source.Accessor;
             string validMeshCode = "53392642";
             string invalidMeshCode = "99999999";
             Assert.IsTrue(DoResultOfFilterByMeshCodesContainsMeshCode(accessor, validMeshCode));
             Assert.IsFalse(DoResultOfFilterByMeshCodesContainsMeshCode(accessor, invalidMeshCode));
         }
 
+        [TestMethod]
+        public void GetGmlFiles()
+        {
+            using var source = DatasetSource.CreateLocal(TestDataPathLocal);
+            var accessor = source.Accessor;
+            using var gmlFiles = accessor.GetAllGmlFiles();
+            Assert.IsTrue(gmlFiles.Length > 0);
+            var firstGml = gmlFiles.At(0);
+            Assert.AreEqual(PredefinedCityModelPackage.Building, firstGml.Package);
+            Assert.AreEqual("53392642", firstGml.MeshCode.ToString());
+        }
+
 
         private static void TestCenterPoint(DatasetSource source)
         {
@@ -150,8 +165,8 @@ private static void TestCenterPoint(DatasetSource source)
             // テスト用のデータは、基準点からおおむね南に50km, 西に5km の地点にあります。
             // ここでいう基準点とは、下のWebサイトにおける 9番の地点です。
             // https://www.gsi.go.jp/sokuchikijun/jpc.html
-            Assert.IsTrue(Math.Abs(center.Z - (-50000)) < 2000, "南に50km"); // Local と Server で値がちょっと違うので2kmの誤差猶予を持たせます。
-            Assert.IsTrue(Math.Abs(center.X - (-5000)) < 1000, "西に5km");
+            Assert.IsTrue(Math.Abs(center.Z - (-51000)) < 2000, "南に51km"); // Local と Server で値がちょっと違うので2kmの誤差猶予を持たせます。
+            Assert.IsTrue(Math.Abs(center.X - (-9000)) < 4000, "西に9km");
         }
         
         
diff --git a/wrappers/csharp/LibPLATEAU.NET/CSharpPLATEAU/Dataset/DatasetAccessor.cs b/wrappers/csharp/LibPLATEAU.NET/CSharpPLATEAU/Dataset/DatasetAccessor.cs
diff --git a/wrappers/csharp/LibPLATEAU.NET/CSharpPLATEAU/Native/NativeVectorGmlFile.cs b/wrappers/csharp/LibPLATEAU.NET/CSharpPLATEAU/Native/NativeVectorGmlFile.cs

Original file line number	Diff line number	Diff line change
`@@ -38,11 +38,13 @@ namespace plateau::dataset {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`void ServerDatasetAccessor::getGmlFiles(`
`41`		`- const PredefinedCityModelPackage package,`
	`41`	`+ const PredefinedCityModelPackage package_flags,`
`42`	`42`	`std::vector<GmlFile>& out_gml_files) {`
`43`	`43`
	`44`	`+ auto arg_package_num = static_cast<std::underlying_type<PredefinedCityModelPackage>::type>(package_flags);`
`44`	`45`	`for (const auto& [sub_folder, gml_files] : dataset_files_) {`
`45`		`- if (UdxSubFolder::getPackage(sub_folder) == package) {`
	`46`	`+ auto data_package_num = static_cast<std::underlying_type<PredefinedCityModelPackage>::type>(UdxSubFolder::getPackage(sub_folder));`
	`47`	`+ if ((data_package_num & arg_package_num) != 0) { // フラグ群の積集合が1つ以上あるなら、引数の package のどれかに合致するので追加`
`46`	`48`	`for (const auto& dataset_file : gml_files) {`
`47`	`49`	`out_gml_files.emplace_back(dataset_file.url, client_, dataset_file.max_lod);`
`48`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,11 @@ namespace plateau::network {`
`78`	`78`	`dataset_metadata.title = json_dataset_metadata.at("title");`
`79`	`79`	`dataset_metadata.description = json_dataset_metadata.at("description");`
`80`	`80`	`if (json_dataset_metadata.contains("featureTypes")) {`
`81`		`- dataset_metadata.feature_types = json_dataset_metadata.at("featureTypes");`
	`81`	`+ auto json_feature_types = json_dataset_metadata.at("featureTypes");`
	`82`	`+ if(json_feature_types.is_array()) { // featureTypes : null の場合を除外`
	`83`	`+ dataset_metadata.feature_types = json_feature_types;`
	`84`	`+ }`
	`85`	`+`
`82`	`86`	`}`
`83`	`87`	`dataset_metadata_group.datasets.push_back(dataset_metadata);`
`84`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ namespace plateau::dataset {`
`19`	`19`	`std::move(DatasetSource::createLocal(u8"../data/日本語パステスト")));`
`20`	`20`	`auto accessor = source->getAccessor();`
`21`	`21`	`auto mesh_code_str = accessor->getMeshCodes().begin()->get();`
`22`		`- ASSERT_EQ(mesh_code_str, "53392642");`
	`22`	`+ ASSERT_EQ(mesh_code_str, "533925");`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`TEST_F(DatasetSourceTest, get_accessor_of_server_source_returns_server_accessor) { // NOLINT`