Repository: dotMorten/DotNetOMDGenerator
Branch: main
Commit: e3394341081a
Files: 24
Total size: 269.9 KB
Directory structure:
gitextract_07wspkb4/
├── .gitignore
├── LICENSE
├── README.md
├── TestCode/
│ ├── NewCode/
│ │ ├── Class1.cs
│ │ ├── Enum1.cs
│ │ ├── Interface1.cs
│ │ └── NmeaParser.xml
│ └── OldCode/
│ ├── Class1.cs
│ ├── Enum1.cs
│ ├── Interface1.cs
│ └── NmeaParser.xml
└── src/
├── Generator/
│ ├── ArgumentParser.cs
│ ├── Generator.csproj
│ ├── Generators/
│ │ ├── HtmlOmdFooter.html
│ │ ├── HtmlOmdGenerator.cs
│ │ ├── HtmlOmdHeader.html
│ │ ├── MarkdownGenerator.cs
│ │ └── OMDGenerator.cs
│ ├── ICodeGenerator.cs
│ ├── Program.cs
│ ├── TypeExtensions.cs
│ ├── WorkspaceHelper.cs
│ └── dotMorten.OmdGenerator.targets
└── Generator.sln
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
# Visual Studio 2015 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUNIT
*.VisualState.xml
TestResult.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
**/Properties/launchSettings.json
*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/packages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Typescript v1 declaration files
typings/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# JetBrains Rider
.idea/
*.sln.iml
# CodeRush
.cr/
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
src/BuildTask/nuget/
================================================
FILE: LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
================================================
FILE: README.md
================================================
# .NET Object Model Diagram Generator
A cross-platform Roslyn-based tool that generates an object model diagram of a set of C# source files and/or .NET assemblies
## Sponsoring
If you like this library and use it a lot, consider sponsoring me. Anything helps and encourages me to keep going.
See here for details: https://github.com/sponsors/dotMorten
### Install
Run the following command from commandline (requires .NET Core 2.1 installed):
```
dotnet tool install --global dotMorten.OmdGenerator
```
### Usage:
```
generateomd /source=[source folder] /compareSource=[oldSourceFolder] /preprocessors=[defines] /format=[html|image] /showPrivate /showInternal
Required parameters:
source Specifies the folder of source files to include for the object model.
Separate with ; for multiple folders
or
assemblies Specifies a set of assemblies to include for the object model.
Separate with ; for multiple assemblies, or use wildcards
Optional parameters:
compareSource Specifies a folder of old source to compare and generate a diff model
This can be useful for finding API changes or compare branches
compareAssemblies Specifies a set of old assemblies to compare and generate a adiff model.
Separate with; for multiple assemblies, or use wildcards
format Format to generate:
'html' a single html output (html is default)
'md' for markdown you can copy-paste to for instance GitHub.
Specify multiple with a semicolon seperator, and use an output filename without extension
preprocessors Define a set of preprocessors values. Use ; to separate multiple
exclude Defines one or more strings that can't be part of the path Ie '*/Samples/*;*/UnitTests/*'
(use forward slash for folder separators)
regexfilter Defines a regular expression for filtering on full file names in the source
showPrivate Show private members (default is false)
showInternal Show internal members (default is false)
output Filename to write the output to (extension is optional, but exclude the extension if you specify multiple formats)
```
### NuGet
As an alternative you can also reference a [NuGet package](https://www.nuget.org/packages/dotMorten.OmdGenerator/) to your class library, and set up a post-build script to generate an Object Model Diagram HTML file:
```
Install-Package dotMorten.OmdGenerator
```
Add the following to your project:
```xml
```
An example of a generated output for all of .NET Core can be found [here](http://www.sharpgis.net/Tests/corefx.html).
It can also be used to compare two folders (for instance two separate branches) and only show changes to the API. [Here's an example of .NET CoreFX v2.0 vs Master](http://www.sharpgis.net/Tests/corefx_new.html).
[](http://www.sharpgis.net/Tests/corefx.html)
### Examples
Generate OMD for .NET Core FX source code, and ignore ref and test folders:
```
generateomd /source=c:\github\dotnet\corefx\src /exclude="*/ref/*;*/tests/*;*/perftests/*"
```
Compare .NET CoreFX Master with v2.0.0 repo branches directly from their Github zipped downloads:
```
generateomd /source=https://github.com/dotnet/corefx/archive/master.zip /compareSource=https://github.com/dotnet/corefx/archive/release/2.0.0.zip /exclude="*/ref/*;*/tests/*;*/perftests/*"
```
What's new in Xamarin.Forms? Compare assemblies from the nuget cache:
```
generateomd /assemblies=%USERPROFILE%\.nuget\packages\xamarin.forms\3.3.0.912540\lib\netstandard2.0\*.dll /compareAsssemblies=%USERPROFILE%\.nuget\packages\xamarin.forms\3.2.0.871581\lib\netstandard2.0\*.dll
```
================================================
FILE: TestCode/NewCode/Class1.cs
================================================
using System;
using System.Threading.Tasks;
public namespace RootNamespace
{
public class BaseClass
{
public abstract void SomeBaseMethod();
public void AVoidMethod() { }
}
public class MyClass : BaseClass, IDisposable
{
MyClass() { }
[Obsolete]
MyClass(int obseleteOverload) { }
public Task ATaskReturningGenericMethod() { }
public double ProtectedSetProperty { get; protected set; }
public double WritableProperty { get; set; }
public double ReadOnlyProperty { get; }
public double SetOnlyProperty { set; }
[Obsolete]
public void AlreadyObsoletedMethod();
[Obsolete]
public void ObsoletedMethod();
[Obsolete]
public double ObsoletedProperty { set; }
public event EventHandler SimpleEvent;
public event EventHandler GenericEvent;
[Obsolete]
public event EventHandler ObsoletedEvent { set; }
public void Dispose() { }
public override void SomeBaseMethod() {}
}
[Obsolete]
public class ObsoletedClass {}
}
================================================
FILE: TestCode/NewCode/Enum1.cs
================================================
using System;
public namespace RootNamespace
{
public enum ShortEnum : short
{
Zero=0, One=1, Two=2
}
public enum SimpleEnum
{
Unknown=-1, One=1, /*Two=2,*/ Three = 3
}
[Flags]
public enum FlagsEnum
{
Zero = 0,
One = 1,
Two = 2,
Four = 4,
[Obsolete]
Obsolete = 5,
All = 255,
}
}
================================================
FILE: TestCode/NewCode/Interface1.cs
================================================
using System;
using System.Threading.Tasks;
public namespace RootNamespace
{
public interface Interface1
{
void Method();
}
public interface DerivedInterface : Interface1
{
void Method2();
}
}
================================================
FILE: TestCode/NewCode/NmeaParser.xml
================================================
NmeaParser
An abstract generic NMEA device that reads a stream at a decreased pace,
mostly used to emulate NMEA input from files and strings.
Initializes a new instance of the class.
Initializes a new instance of the class.
The time to wait between each group of lines being read in milliseconds
Gets the stream to perform buffer reads on.
Opens the stream asynchronous.
Closes the stream asynchronous.
The stream.
Initializes a new instance of the class.
The stream.
The read speed in milliseconds.
Gets a value indicating whether this instance can read.
true if this instance can read; otherwise, false.
Gets a value indicating whether this instance can seek.
true if this instance can seek; otherwise, false.
Gets a value indicating whether this instance can write.
true if this instance can write; otherwise, false.
Flushes this instance.
Gets the length.
The length.
Gets or sets the position.
The position.
Reads the specified buffer.
The buffer.
The offset.
The count.
Seeks the specified offset.
The offset.
The origin.
Sets the length.
The value.
Writes the specified buffer to the device.
The buffer.
The offset.
The count.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Total number of messages of this type in this cycle
Message number
A generic abstract NMEA device
Initializes a new instance of the class.
Opens the device connection.
Creates the stream the NmeaDevice is working on top off.
Closes the device.
Closes the stream the NmeaDevice is working on top off.
The stream.
Occurs when an NMEA message is received.
Releases unmanaged and - optionally - managed resources.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a value indicating whether this device is open.
true if this instance is open; otherwise, false.
Event argument for the
Gets the nmea message.
The nmea message.
Gets a value indicating whether this instance is a multi part message.
true if this instance is multi part; otherwise, false.
Gets the message parts if this is a multi-part message and all message parts has been received.
The message parts.
A file-based NMEA device reading from a NMEA log file.
Initializes a new instance of the class.
Initializes a new instance of the class.
The time to wait between each group of lines being read in milliseconds
Gets the name of the nmea file this device is using.
Gets the stream to perform buffer reads on.
GALILEO Satellites in view
Global Positioning System Fix Data
Called when the message is being loaded.
The NMEA message values.
Time of day fix was taken
Latitude
Longitude
Fix Quality
Number of satellites being tracked
Horizontal Dilution of Precision
Altitude
Altitude units ('M' for Meters)
Height of geoid (mean sea level) above WGS84
Altitude units ('M' for Meters)
Time since last DGPS update
DGPS Station ID Number
Geographic position, latitude / longitude
Called when the message is being loaded.
The NMEA message values.
Latitude
Longitude
Time since last DGPS update
Gets a value indicating whether data is active.
true if data is active; otherwise, false.
Fix data for GLONASS satellite navigation systems
GLONASS Satellites in view
Fixes data for single or combined (GPS, GLONASS, possible future satellite systems, and systems combining these) satellite navigation systems
GNS Mode Indicator
No fix. Satellite system not used in position fix, or fix not valid
Autonomous. Satellite system used in non-differential mode in position fix
Differential (including all OmniSTAR services). Satellite system used in differential mode in position fix
Precise. Satellite system used in precision mode. Precision mode is defined as no deliberate degradation (such as Selective Availability) and higher resolution code (P-code) is used to compute position fix.
Real Time Kinematic. Satellite system used in RTK mode with fixed integers
Float RTK. Satellite system used in real time kinematic mode with floating integers
Estimated (dead reckoning) mode
Manual input mode
Simulator mode
Navigational status
Not valid for navigation
Safe
Caution
Unsafe
Called when the message is being loaded.
The NMEA message values.
Time of day fix was taken
Latitude
Longitude
Mode indicator for GPS
Mode indicator for GLONASS
Mode indicator for future constallations
Number of satellites (SVs) in use
Horizontal Dilution of Precision (HDOP), calculated using all the satellites (GPS, GLONASS, and any future satellites) used in computing the solution reported in each GNS sentence.
Orthometric height in meters (MSL reference)
Geoidal separation in meters - the difference between the earth ellipsoid surface and mean-sea-level (geoid) surface defined by the reference datum used in the position solution
'-' = mean-sea-level surface below ellipsoid.
Age of differential data - if talker ID is GN, additional GNS messages follow with GP and/or GL Age of differential data
eference station ID1, range 0000-4095 - Null if talker ID is GN, additional GNS messages follow with GP and/or GL Reference station ID
Navigational status
Global Positioning System Fix Data
Geographic position, latitude / longitude
Global Positioning System Fix Data
Position error statistics
Recommended Minimum
Fixes data for single or combined (GPS, GLONASS, possible future satellite systems, and systems combining these) satellite navigation systems
Recommended Minimum
Called when the message is being loaded.
The NMEA message values.
Estimated horizontal position error in meters (HPE)
Range: 0.0 to 999.9 meters
Horizontal Error unit ('M' for Meters)
Estimated vertical position error in meters (VPE)
Range: 0.0 to 999.9 meters
Vertical Error unit ('M' for Meters)
Overall spherical equivalent position error (EPE)
Range: 0.0 to 999.9 meters
Spherical Error unit ('M' for Meters)
Altitude Information
Altitude unit
Unknown
Feet
Position Fix Dimension
Unknown
No fix
2D Fix
3D Fix
Called when the message is being loaded.
The NMEA message values.
Current altitude
Horizontal Error unit ('f' for Meters)
Fix type
Bearing Origin to Destination
Called when the message is being loaded.
The NMEA message values.
True Bearing from start to destination
Magnetic Bearing from start to destination
Name of origin
Name of destination
Global Positioning System Fix Data
Fix quality
Invalid
GPS
Differential GPS
Precise Positioning Service
Real Time Kinematic (Fixed)
Real Time Kinematic (Floating)
Estimated
Manual input
Simulation
Geographic position, latitude / longitude
Fixes data for GPS satellite navigation systems
Global Positioning System Fix Data
Mode selection
Auto
Manual mode
Fix Mode
Not available
2D Fix
3D Fix
Position error statistics
GLONASS Satellites in view
Satellite vehicle
SV PRN number
Elevation in degrees, 90 maximum
Azimuth, degrees from true north, 000 to 359
Signal-to-Noise ratio, 0-99 dB (-1 when not tracking)
Satellite system
Satellite system
Unknown
GPS - Global Positioning System (NAVSTAR)
WAAS - Wide Area Augmentation System
GLONASS - Globalnaya navigatsionnaya sputnikovaya sistema
Galileo
Recommended minimum navigation information
Data status
Ok
Warning
Called when the message is being loaded.
The NMEA message values.
Data Status
Cross-track error (steer left when negative, right when positive)
Origin waypoint ID
Destination waypoint ID
Destination Latitude
Destination Longitude
Range to destination in nautical miles
True bearing to destination
Velocity towards destination in knots
Arrived (true if arrived)
Recommended Minimum
Routes
Waypoint tpe
Complete list of waypoints
List of remaining waypoints
Called when the message is being loaded.
The NMEA message values.
Total number of messages of this type in this cycle
Message number
Gets the type of the list.
Gets the route identifier.
Waypoints
Returns an enumerator that iterates through the collection.
A System.Collections.Generic.IEnumerator{T} that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
Global Positioning System Fix Data
Called when the message is being loaded.
The NMEA message values.
Mode
Mode
IDs of SVs used in position fix
Dilution of precision
Horizontal dilution of precision
Vertical dilution of precision
Position error statistics
Called when the message is being loaded.
The NMEA message values.
UTC of position fix
RMS value of the pseudorange residuals; includes carrier phase residuals during periods of RTK (float) and RTK (fixed) processing
Error ellipse semi-major axis 1 sigma error, in meters
Error ellipse semi-minor axis 1 sigma error, in meters
Error ellipse orientation, degrees from true north
Latitude 1 sigma error, in meters
The error expressed as one standard deviation.
Longitude 1 sigma error, in meters
The error expressed as one standard deviation.
Height 1 sigma error, in meters
The error expressed as one standard deviation.
GPS Satellites in view
Called when the message is being loaded.
The NMEA message values.
Total number of messages of this type in this cycle
Message number
Total number of SVs in view
Dilution of precision
Returns an enumerator that iterates through the collection.
A System.Collections.Generic.IEnumerator{SatelliteVehicle} that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
Laser Range Measurement
Called when the message is being loaded.
The NMEA message values.
Gets the horizontal vector.
Gets the horizontal distance.
Gets the units of the value.
Gets the horizontal angle.
Gets the units of the value.
Gets the vertical angle.
Gets the units of the value.
Gets the slope distance.
Gets the units of the value.
Laser Range
Burden finder
Tree Measurement
Called when the message is being loaded.
The NMEA message values.
Gets the height of the tree.
Gets the message height of the tree.
Gets the units of the value.
Gets the tree diameter.
Gets the measured tree diameter.
Gets the units of the value.
Nmea message attribute type used on concrete implementations.
Initializes a new instance of the class.
The type.
Gets or sets the NMEA message type.
NMEA Message base class.
Parses the specified NMEA message.
The NMEA message string.
Invalid nmea message: Missing starting character '$'
or checksum failure
Gets the NMEA message parts.
Gets the NMEA type id for the message.
Called when the message is being loaded.
The NMEA message values.
Implement this method to create a custom NMEA message.
Returns a that represents this instance.
A that represents this instance.
Gets the checksum value of the message.
Recommended Minimum
Called when the message is being loaded.
The NMEA message values.
Fix Time
Gets a value whether the device is active
Latitude
Longitude
Speed over the ground in knots
Track angle in degrees True
Magnetic Variation
Represents an unknown message type
Gets the nmea value array.
Called when the message is being loaded.
The NMEA message values.
Generic stream device
Initializes a new instance of the class.
The stream.
Opens the stream asynchronous.
Closes the stream asynchronous.
The stream.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
================================================
FILE: TestCode/OldCode/Class1.cs
================================================
using System;
using System.Threading.Tasks;
public namespace RootNamespace
{
public class BaseClass
{
public abstract void SomeBaseMethod();
}
public class MyClass : IDisposable
{
MyClass() { }
MyClass(int obseleteOverload) { }
public void AVoidMethod() { }
public Task ATaskReturningGenericMethod() { }
public double ProtectedSetProperty { get; protected set; }
public double WritableProperty { get; set; }
public double ReadOnlyProperty { get; }
public double SetOnlyProperty { set; }
[Obsolete]
public void AlreadyObsoletedMethod();
public double ObsoletedProperty { set; }
public void ObsoletedMethod();
public event EventHandler SimpleEvent;
public event EventHandler GenericEvent;
public event EventHandler ObsoletedEvent { set; }
public void Dispose() { }
}
public class ObsoletedClass {}
}
================================================
FILE: TestCode/OldCode/Enum1.cs
================================================
using System;
public namespace RootNamespace
{
public enum ShortEnum : long
{
Zero=0, One=1, Two=2
}
public enum SimpleEnum
{
Unknown=0, One=1, Two=2
}
[Flags]
public enum FlagsEnum
{
Zero = 0,
One = 1,
Two = 2,
Four = 4,
Obsolete = 5,
All = 255,
}
}
================================================
FILE: TestCode/OldCode/Interface1.cs
================================================
using System;
using System.Threading.Tasks;
public namespace RootNamespace
{
public interface Interface1
{
void Method();
}
public interface DerivedInterface : Interface1
{
void Method2();
}
}
================================================
FILE: TestCode/OldCode/NmeaParser.xml
================================================
NmeaParser
An abstract generic NMEA device that reads a stream at a decreased pace,
mostly used to emulate NMEA input from files and strings.
Initializes a new instance of the class.
Initializes a new instance of the class.
The time to wait between each group of lines being read in milliseconds
Gets the stream to perform buffer reads on.
Opens the stream asynchronous.
Closes the stream asynchronous.
The stream.
Initializes a new instance of the class.
The stream.
The read speed in milliseconds.
Gets a value indicating whether this instance can read.
true if this instance can read; otherwise, false.
Gets a value indicating whether this instance can seek.
true if this instance can seek; otherwise, false.
Gets a value indicating whether this instance can write.
true if this instance can write; otherwise, false.
Flushes this instance.
Gets the length.
The length.
Gets or sets the position.
The position.
Reads the specified buffer.
The buffer.
The offset.
The count.
Seeks the specified offset.
The offset.
The origin.
Sets the length.
The value.
Writes the specified buffer to the device.
The buffer.
The offset.
The count.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Total number of messages of this type in this cycle
Message number
A generic abstract NMEA device
Initializes a new instance of the class.
Opens the device connection.
Creates the stream the NmeaDevice is working on top off.
Closes the device.
Closes the stream the NmeaDevice is working on top off.
The stream.
Occurs when an NMEA message is received.
Releases unmanaged and - optionally - managed resources.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets a value indicating whether this device is open.
true if this instance is open; otherwise, false.
Event argument for the
Gets the nmea message.
The nmea message.
Gets a value indicating whether this instance is a multi part message.
true if this instance is multi part; otherwise, false.
Gets the message parts if this is a multi-part message and all message parts has been received.
The message parts.
A file-based NMEA device reading from a NMEA log file.
Initializes a new instance of the class.
Initializes a new instance of the class.
The time to wait between each group of lines being read in milliseconds
Gets the name of the nmea file this device is using.
Gets the stream to perform buffer reads on.
Position error statistics
Called when the message is being loaded.
The NMEA message values.
UTC of position fix
RMS value of the pseudorange residuals; includes carrier phase residuals during periods of RTK (float) and RTK (fixed) processing
Error ellipse semi-major axis 1 sigma error, in meters
Error ellipse semi-minor axis 1 sigma error, in meters
Error ellipse orientation, degrees from true north
Latitude 1 sigma error, in meters
The error expressed as one standard deviation.
Longitude 1 sigma error, in meters
The error expressed as one standard deviation.
Height 1 sigma error, in meters
The error expressed as one standard deviation.
Recommended Minimum
Called when the message is being loaded.
The NMEA message values.
Estimated horizontal position error in meters (HPE)
Range: 0.0 to 999.9 meters
Horizontal Error unit ('M' for Meters)
Estimated vertical position error in meters (VPE)
Range: 0.0 to 999.9 meters
Vertical Error unit ('M' for Meters)
Overall spherical equivalent position error (EPE)
Range: 0.0 to 999.9 meters
Spherical Error unit ('M' for Meters)
Altitude Information
Altitude unit
Unknown
Feet
Position Fix Dimension
Unknown
No fix
2D Fix
3D Fix
Called when the message is being loaded.
The NMEA message values.
Current altitude
Horizontal Error unit ('M' for Meters)
Fix type
Bearing Origin to Destination
Called when the message is being loaded.
The NMEA message values.
True Bearing from start to destination
Magnetic Bearing from start to destination
Name of origin
Name of destination
Global Positioning System Fix Data
Fix quality
Invalid
GPS
Differential GPS
Precise Positioning Service
Real Time Kinematic (Fixed)
Real Time Kinematic (Floating)
Estimated
Manual input
Simulation
Called when the message is being loaded.
The NMEA message values.
Time of day fix was taken
Latitude
Longitude
Fix Quality
Number of satellites being tracked
Horizontal Dilution of Precision
Altitude
Altitude units ('M' for Meters)
Height of geoid (mean sea level) above WGS84
Altitude units ('M' for Meters)
Time since last DGPS update
DGPS Station ID Number
Geographic position, latitude / longitude
Called when the message is being loaded.
The NMEA message values.
Latitude
Longitude
Time since last DGPS update
Gets a value indicating whether data is active.
true if data is active; otherwise, false.
Global Positioning System Fix Data
Mode selection
Auto
Manual mode
Fix Mode
Not available
2D Fix
3D Fix
Called when the message is being loaded.
The NMEA message values.
Mode
Mode
IDs of SVs used in position fix
Dilution of precision
Horizontal dilution of precision
Vertical dilution of precision
Position error statistics
Called when the message is being loaded.
The NMEA message values.
UTC of position fix
RMS value of the pseudorange residuals; includes carrier phase residuals during periods of RTK (float) and RTK (fixed) processing
Error ellipse semi-major axis 1 sigma error, in meters
Error ellipse semi-minor axis 1 sigma error, in meters
Error ellipse orientation, degrees from true north
Latitude 1 sigma error, in meters
The error expressed as one standard deviation.
Longitude 1 sigma error, in meters
The error expressed as one standard deviation.
Height 1 sigma error, in meters
The error expressed as one standard deviation.
GPS Satellites in view
Called when the message is being loaded.
The NMEA message values.
Total number of messages of this type in this cycle
Message number
Total number of SVs in view
Dilution of precision
Returns an enumerator that iterates through the collection.
A System.Collections.Generic.IEnumerator{SatelliteVehicle} that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
Satellite vehicle
SV PRN number
Elevation in degrees, 90 maximum
Azimuth, degrees from true north, 000 to 359
Signal-to-Noise ratio, 0-99 dB (-1 when not tracking)
Satellite system
Satellite system
Unknown
GPS - Global Positioning System (NAVSTAR)
WAAS - Wide Area Augmentation System
GLONASS - Globalnaya navigatsionnaya sputnikovaya sistema
Recommended minimum navigation information
Data status
Ok
Warning
Called when the message is being loaded.
The NMEA message values.
Data Status
Cross-track error (steer left when negative, right when positive)
Origin waypoint ID
Destination waypoint ID
Destination Latitude
Destination Longitude
Range to destination in nautical miles
True bearing to destination
Velocity towards destination in knots
Arrived (true if arrived)
Recommended Minimum
Called when the message is being loaded.
The NMEA message values.
Fix Time
Gets a value whether the device is active
Latitude
Longitude
Speed over the ground in knots
Track angle in degrees True
Magnetic Variation
Routes
Waypoint tpe
Complete list of waypoints
List of remaining waypoints
Called when the message is being loaded.
The NMEA message values.
Total number of messages of this type in this cycle
Message number
Gets the type of the list.
Gets the route identifier.
Waypoints
Returns an enumerator that iterates through the collection.
A System.Collections.Generic.IEnumerator{T} that can be used to iterate through the collection.
Returns an enumerator that iterates through a collection.
An System.Collections.IEnumerator object that can be used to iterate through the collection.
Laser Range Measurement
Called when the message is being loaded.
The NMEA message values.
Gets the horizontal vector.
Gets the horizontal distance.
Gets the units of the value.
Gets the horizontal angle.
Gets the units of the value.
Gets the vertical angle.
Gets the units of the value.
Gets the slope distance.
Gets the units of the value.
Laser Range
Burden finder
Tree Measurement
Called when the message is being loaded.
The NMEA message values.
Gets the height of the tree.
Gets the message height of the tree.
Gets the units of the value.
Gets the tree diameter.
Gets the measured tree diameter.
Gets the units of the value.
Nmea message attribute type used on concrete implementations.
Initializes a new instance of the class.
The type.
Gets or sets the NMEA message type.
NMEA Message base class.
Parses the specified NMEA message.
The NMEA message string.
Invalid nmea message: Missing starting character '$'
or checksum failure
Gets the NMEA message parts.
Gets the NMEA type id for the message.
Called when the message is being loaded.
The NMEA message values.
Implement this method to create a custom NMEA message.
Returns a that represents this instance.
A that represents this instance.
Gets the checksum value of the message.
Represents an unknown message type
Gets the nmea value array.
Called when the message is being loaded.
The NMEA message values.
Generic stream device
Initializes a new instance of the class.
The stream.
Opens the stream asynchronous.
Closes the stream asynchronous.
The stream.
Releases unmanaged and - optionally - managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
================================================
FILE: src/Generator/ArgumentParser.cs
================================================
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Text;
using System.Text.RegularExpressions;
namespace Generator
{
static class ArgumentParser
{
// Based on https://www.codeproject.com/Articles/3111/C-NET-Command-Line-Arguments-Parser
public static StringDictionary Parse(string[] arguments)
{
StringDictionary Parameters = new StringDictionary();
Regex Spliter = new Regex(@"^-{1,2}|^/|=|:",
RegexOptions.IgnoreCase | RegexOptions.Compiled);
Regex Remover = new Regex(@"^['""]?(.*?)['""]?$",
RegexOptions.IgnoreCase | RegexOptions.Compiled);
string Parameter = null;
string[] Parts;
// Valid parameters forms:
// {-,/,--}param{ ,=,:}((",')value(",'))
// Examples:
// -param1 value1 --param2 /param3:"Test-:-work"
// /param4=happy -param5 '--=nice=--'
foreach (string Txt in arguments)
{
// Look for new parameters (-,/ or --) and a
// possible enclosed value (=,:)
Parts = Spliter.Split(Txt, 3);
switch (Parts.Length)
{
// Found a value (for the last parameter
// found (space separator))
case 1:
if (Parameter != null)
{
if (!Parameters.ContainsKey(Parameter))
{
Parts[0] =
Remover.Replace(Parts[0], "$1");
Parameters.Add(Parameter, Parts[0]);
}
Parameter = null;
}
// else Error: no parameter waiting for a value (skipped)
break;
// Found just a parameter
case 2:
// The last parameter is still waiting.
// With no value, set it to true.
if (Parameter != null)
{
if (!Parameters.ContainsKey(Parameter))
Parameters.Add(Parameter, "true");
}
Parameter = Parts[1];
break;
// Parameter with enclosed value
case 3:
// The last parameter is still waiting.
// With no value, set it to true.
if (Parameter != null)
{
if (!Parameters.ContainsKey(Parameter))
Parameters.Add(Parameter, "true");
}
Parameter = Parts[1];
// Remove possible enclosing characters (",')
if (!Parameters.ContainsKey(Parameter))
{
Parts[2] = Remover.Replace(Parts[2], "$1");
Parameters.Add(Parameter, Parts[2]);
}
Parameter = null;
break;
}
}
if (Parameter != null)
{
if (!Parameters.ContainsKey(Parameter))
Parameters.Add(Parameter, "true");
}
return Parameters;
}
}
}
================================================
FILE: src/Generator/Generator.csproj
================================================
Exe
net6.0
latest
true
DotnetTool,DotNetCliTool
generateomd
./../nupkg
dotMorten.OmdGenerator
1.5.2
Morten Nielsen
OMD Generator
Automatically generates an HTML Document with an object model diagram for your C# library<
Copyright © 2018 Morten Nielsen
https://github.com/dotMorten/DotNetOMDGenerator
https://github.com/dotMorten/DotNetOMDGenerator
OMD Diagram CSharp Roslyn
true
generateomd
Major
================================================
FILE: src/Generator/Generators/HtmlOmdFooter.html
================================================
Generated with .NET Object Model Diagram Generator