Arcadis.CWZ.V1 1.0.0-preview.9

Arcadis CWZ (Connected Work Zones) .NET Library

This repository contains the source code for Arcadis's .NET 9.0 CWZ (Connected Work Zones) V1 class library, Arcadis.CWZ.V1.

About

The Arcadis.CWZ.V1 class library provides models and utilities for producing and consuming data feeds following the Connected Work Zones Implementation Guide and Standard v01.00.

The library provides the following functionality:

• Utilize CWZ concepts in .NET code.
• Create a CWZ WorkZoneFeed GeoJSON string by serializing CWZ C# objects modeled in this library.
• Deserialize a CWZ Work Zone Feed GeoJSON string into C# objects modeled in this library.

CWZ Version Support

The versioning is implemented at the namespace level, allowing consumers to explicitly select which version of the CWZ standard they want to work with. Currently, only V1 is available, but when future versions are introduced (such as V2), consumers will be able to choose between versions by importing the appropriate namespace.

The CWZ DeviceFeed is not yet supported by this library.

Usage

NuGet Package

To use the library, you need to reference it in your .NET project. The easiest way to do this is to add the Arcadis.CWZ.V1 NuGet package, available from nuget.org, as a dependency to your project:

dotnet add package Arcadis.CWZ.V1

Create a CWZ feed GeoJSON string

Use the CwzSerializer static class to serialize a CWZ feed object into a GeoJSON string that represents a valid CWZ feed object.

For example:

using Arcadis.CWZ.V1.Models;
using Arcadis.CWZ.V1.Serialization;

var myCwzWorkZoneFeed = new WorkZoneFeed(...);

string cwzGeoJsonString = CwzSerializer.SerializeFeed(myCwzWorkZoneFeed);

Read in a CWZ feed GeoJSON string

Use the CwzSerializer static class to deserialize a CWZ feed JSON string into an Arcadis.CWZ.V1 library model representation of the feed content.

For Example:

using Arcadis.CWZ.V1.Models;
using Arcadis.CWZ.V1.Serialization;

var httpClient = new HttpClient();

HttpResponseMessage feedResponse = await httpClient.GetAsync("https://url.to.cwz.feed/cwz-work-zone-feed");
string cwzWorkZoneFeedGeoJson = await feedResponse.Content.ReadAsStringAsync();

WorkZoneFeed cwzWorkZoneFeed = CwzSerializer.DeserializeFeed<WorkZoneFeed>(cwzWorkZoneFeedGeoJson);

Versioning

The package uses Semantic Versioning in a MAJOR.MINOR.PATCH format.

Tests

This solution includes an Arcadis.CWZ.V1.UnitTests Xunit test project. Run all unit tests with the following command:

dotnet test