OSMDataPrimitives.BSON 2.1.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package OSMDataPrimitives.BSON --version 2.1.1                
NuGet\Install-Package OSMDataPrimitives.BSON -Version 2.1.1                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OSMDataPrimitives.BSON" Version="2.1.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OSMDataPrimitives.BSON --version 2.1.1                
#r "nuget: OSMDataPrimitives.BSON, 2.1.1"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install OSMDataPrimitives.BSON as a Cake Addin
#addin nuget:?package=OSMDataPrimitives.BSON&version=2.1.1

// Install OSMDataPrimitives.BSON as a Cake Tool
#tool nuget:?package=OSMDataPrimitives.BSON&version=2.1.1                

license codeql_analysis nuget_version github_tag Quality Gate Status Coverage

OSMDataPrimitives

Intention

This pretty little project is intended to provide the 3 basic data types (nodes, ways and relations) of OpenStreetMap as .NET classes. I'm about to use it in some other projects.

Usage

To create new instances of an OSMNode:

using OSMDataPrimitives;

var node = new OSMNode(1, 52.123456, 12.654321) {
	UserId = 1,
	UserName = "username",
	Version = 1,
	Changeset = 1,
	Timestamp = DateTime.Now
};
node.Tags.Add("name", "foo");
node.Tags.Add("ref", "bar");

It's also easy to create new instances of an OSMWay:

var way = new OSMWay(1) {
	UserId = 1,
	UserName = "username",
	Version = 1,
	Changeset = 1,
	TimeStamp = DateTime.Now
};
way.Tags.Add("name", "first road");
way.Tags.Add("ref", "A1");
way.NodeRefs.Add(1);
way.NodeRefs.Add(2);
way.NodeRefs.Add(3);
way.NodeRefs.Add(4);

And last but not least an OSMRelation:

var relation = new OSMRelation(1) {
	UserId = 1,
	UserName = "username",
	Version = 1,
	Changeset = 1,
	TimeStamp = DateTime.Now
};
relation.Tags.Add("name", "my little country");
relation.Tags.Add("note", "just a test.");
relation.Members.Add(new OSMMember(MemberType.Way, 1, "outer"));
relation.Members.Add(new OSMMember(MemberType.Way, 2, "outer"));

To simply convert these OSMElement's to a XML-String or a XmlElement:

using OSMDataPrimitives;
using OSMDataPrimitives.Xml;

var node = new OSMNode(1, 52.123456, 12.654321) {
	UserId = 1,
	UserName = "username",
	Version = 1,
	Changeset = 1,
	Timestamp = DateTime.Now
};
node.Tags.Add("name", "foo");
node.Tags.Add("ref", "bar");

var xmlString = node.ToXmlString();
Console.WriteLine(xmlString);
/*
 * output:
 * <node id="1" lat="52.123456" lon="12.654321" version="1" uid="1" user="username" changeset="1" timestamp="2017-01-31T12:34:17Z"><tag k="name" v="foo" /><tag k="ref" v="bar" /></node>
 */

var xmlElement = node.ToXml();
Console.WriteLine(xmlElement.OuterXml);
/*
 * output (the same as above):
 * <node id="1" lat="52.123456" lon="12.654321" version="1" uid="1" user="username" changeset="1" timestamp="2017-01-31T12:36:09Z"><tag k="name" v="foo" /><tag k="ref" v="bar" /></node>
 */

It is also possible to build PostgreSQL queries for the OSMElement's:

var node = new OSMNode(1, 52.123456, 12.654321) {
	UserId = 1,
	UserName = "username",
	Version = 1,
	Changeset = 1,
	Timestamp = DateTime.Now
};
node.Tags.Add("name", "foo");
node.Tags.Add("ref", "bar");

NameValueCollection sqlParameters;
var sqlQuery = node.ToPostgreSQLInsert(out sqlParameters);
Console.WriteLine(sqlQuery);
/*
 * output:
 * INSERT INTO nodes (osm_id, lat, lon, tags) VALUES(@osm_id::bigint, @lat::double precision, @lon::double precision, @tags::hstore)
 *
 * The values for @osm_id, @lat, @lon and @tags are put into the sqlParameters-variable.
 */

// to add all the meta-data:
sqlQuery = node.ToPostgreSQLInsert(out sqlParameters, inclusiveMetaFields: true);
Console.WriteLine(sqlQuery);
/*
 * output:
 * INSERT INTO nodes (osm_id, version, changeset, uid, user, timestamp, lat, lon, tags) VALUES(@osm_id::bigint, @version::bigint, @changeset::bigint, @uid::bigint, @user, TIMESTAMP @timestamp, @lat::double precision, @lon::double precision, @tags::hstore)

License

CC0-1.0.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.2 163 2/1/2024
2.2.1 102 1/30/2024
2.2.0 95 1/29/2024
2.1.3 172 1/8/2024
2.1.2 200 11/22/2023
2.1.1 109 11/22/2023
2.1.0 114 11/20/2023
2.0.1 236 4/3/2023
2.0.0 205 4/3/2023
1.3.0 535 11/19/2020
1.2.2 498 7/3/2020
1.2.1 744 12/6/2018
1.2.0 878 11/14/2017
1.0.13 965 6/22/2017
1.0.12 932 6/21/2017
1.0.8 957 2/9/2017
1.0.6 922 1/30/2017
1.0.4 950 1/23/2017
1.0.3 965 1/22/2017

changed target framework to .NET 6.0 - .NET 8.0