DEH-CSV 1.3.0

DEH-CSV

The Digital Engineering Hub CSV DEH-CSV library is used to convert an ECSS-E-TM-10-25 data set into a CSV files.

Installation

The packages are available on Nuget at https://www.nuget.org/packages/DEH-CSV/

Quickstart

1. Install the nuget package into your project or solution.

Write

1. Add a mapping file that states how the properties of an ECSS-E-TM-10-25 Thing needs to be mapped to fields in a CSV file.
2. Use the ICsvWriter interface and/or the CsvWriter class.

The ICsvWriter interface exposes only one method: write.

 public void Write(Iteration iteration, bool includeNestedElements, IEnumerable<TypeMap> maps, DirectoryInfo target, object options);

• iteration: Proive an Iteration instance that provides access to all the Things that need to be exported, this includes the container EngineeringMoedel and the SiteDirectory.
• includeNestedElements: A value that indicates whether a volatile nested element tree needs to be generated for each Option in the provided Iteration and added to the Thing instances for which CSVs are to be written.
• maps: a collection of TypeMaps that contain the configuration of how a certain kind of Thing is to be mapped to fields in a CSV file.
• target: the target directory where the CSV files are to be generated.
• options: any kind of object that can contain configuration information (this is igonred by the standard implementation but can be used when a derived CsvWriter is created where the Write method is overriden).

Read

1. Add a mapping file that states of a CSV file needs to be mapped to the properties of an ECSS-E-TM-10-25 Thing
2. Add the corresponding CSV file that needs to be processed
3. Use the ICsvReader interface and/or the CsvReader class.

The ICsvReader interface exposes only one method: read.

 public Task<IEnumerable<Thing>> Read(Stream stream, IReadOnlyCollection<TypeMap> typeMaps, ISession session);

• stream: The Stream that contains CSV content
• typeMaps: The collection of TypeMaps
• session: The ISession that helps to retrieve Thing
• returns: A Task that contains a collection of mapped Things

After the read is done, all mapped Things can be written to the Isession by adding them to the correct TopContainer. A manual action will need to be done there, unless a TypeMap is created to perform that action.

Build Status

GitHub actions are used to build and test the libraries

Branch	Build Status
Master
Development

License

The DEH-CSV libraries are provided to the community under the Apache License 2.0.