Prerequisites

Before you begin, ensure you have met the following requirements:

• Compatible .NET framework installed (see Compatibility section above)
• Visual Studio 2019 or newer (for development)

Installation

To use Walter.BOM in your project, install it via NuGet Package Manager or the .NET CLI:

dotnet add package Walter.BOM

some samples

You can have a look at the Walter.BOM.chm help directory and get a lot more infomation about the capebilities in Walter.BOM.

GEO

Console application demonstrating some of the GEO API. the bellow code is AoT compliant and will generate a native exe demonstrated in GitHub

    internal class Program
    {
        static void Main(string[] args)
        {
            Console.OutputEncoding = System.Text.Encoding.UTF8;

            Console.WriteLine("Enter the 2 letter ISO code of a country and press enter:");

            //display the name in localized yountry in the language of the country
            var country = Walter.BOM.Geo.GeoLocation.UnKnown;
            do
            {
                var letters = Console.ReadLine()?.Trim();
                if (string.IsNullOrEmpty(letters)
                    || letters.Length != 2
                    || !GeoLocationMapping.TryGetValue(letters, out var mapping))
                {
                    Console.WriteLine("2 letter country code, like DE, NL, US, TR , TH, JP ...");
                }
                else
                {
                    country = mapping;
                }
            } while (country == GeoLocation.UnKnown);
            var capitol = country.GetCapitol();
            
            Console.WriteLine();
            Console.WriteLine($"CITY: {capitol.City}");
            Console.WriteLine($"LOCALIZED COUNTRY: {country.GetInternationalCountryName(country)}");
            Console.WriteLine($"en-US COUNTRY: {country.GetCountryName()}");
            Console.WriteLine($"GPS LAT/LONG: {capitol.Lat.LatitudeDegrees()}/{capitol.Lng.LongitudeDegrees()}");
            Console.WriteLine($"DMS LAT/LONG: {capitol.Lat.ToDmsLatitude()}/{capitol.Lng.ToDmsLongitude()}");
            Console.CancelKeyPress += Console_CancelKeyPress;
            OpenLocationInGoogleMaps(capitol.Lng, capitol.Lat);

            
            #if !DEBUG
            Console.WriteLine("Press any key to exit");
            Console.ReadKey();
            #endif

            Console.CancelKeyPress -= Console_CancelKeyPress;
        }

        private static void Console_CancelKeyPress(object? sender, ConsoleCancelEventArgs e)
        {
            Console.CancelKeyPress -= Console_CancelKeyPress;
            Process.GetCurrentProcess().Kill();
        }

        static void OpenLocationInGoogleMaps(double latitude, double longitude)
        {
            Console.WriteLine("Enter your google GEO API key and press enter (CTRL+C to exit):");
            var key = Console.ReadLine();

            // Generate the Google Maps URL: 
            string mapsUrl = $"https://maps.googleapis.com/maps/api/geocode/json?latlng={latitude},{longitude}&key={key}";

            Console.WriteLine(mapsUrl);
            // Open the URL in the default browser
            try
            {
                OpenUrl(mapsUrl);
            }
            catch (Exception ex)
            {
                Console.WriteLine("An error occurred while trying to open the URL: " + ex.Message);
            }

            static void OpenUrl(string url)
            {
                if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
                {
                    Process.Start(new ProcessStartInfo("cmd", $"/c start {url}") { CreateNoWindow = true });
                }
                else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
                {
                    Process.Start("xdg-open", url);
                }
                else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
                {
                    Process.Start("open", url);
                }
            }
        }
    }

Introduction to NetworkService Example

The NetworkService class is a simple demonstration of how the Walter.BOM library can be utilized to manage and validate network addresses within your application. Specifically, this example showcases how to determine if an IP address is IPv4, which is currently supported, versus IPv6, which is intentionally not implemented in the current release. This approach leverages the NotImplementedByDesignException to clearly indicate features that are out of scope, improving code clarity and maintainability. Below is a sample implementation of the NetworkService class, which includes a method to check IP address support.

public class NetworkService
{
    public void CheckIPAddressSupport(IPAddress ipAddress)
    {
        if (ipAddress.AddressFamily == System.Net.Sockets.AddressFamily.InterNetworkV6)
        {
            // IPv6 is found to be out of scope for the current release
            throw new NotImplementedByDesignException("IPv6 support is out of scope for the current release.");
        }
        else
        {
            Console.WriteLine("IPv4 address is supported.");
        }
    }
}

Introduction to Program Main Method Example

The following code snippet demonstrates a practical application of the NetworkService within a console application. This example specifically illustrates error handling in scenarios where unsupported IPv6 addresses are encountered. By attempting to check the support for an IPv6 address, the application intentionally triggers a NotImplementedByDesignException. This exception is then gracefully caught and processed, providing the user with detailed feedback, including the method name, file path, and line number where the exception was thrown. This pattern is invaluable for debugging and supports a robust development process by explicitly handling out-of-scope functionality.

The documentation section of this github repository contains a AoT sample showing the use.

class Program
{
    static void Main(string[] args)
    {


        var color= Console.ForegroundColor;
        var networkService = new NetworkService();
        try
        {
            // Assuming an IPv6 address for demonstration
            IPAddress ipv6Address = IPAddress.Parse("2001:0db8:85a3:0000:0000:8a2e:0370:7334");
            networkService.CheckIPAddressSupport(ipv6Address);
        }
        catch (NotImplementedByDesignException ex)
        {
            Console.ForegroundColor = ConsoleColor.Red;

            Console.WriteLine($"Error: {ex.Message}");
            Console.ForegroundColor = ConsoleColor.Yellow;
            Console.WriteLine("Please contact support with the following details:");
            Console.WriteLine($"Member Name: {ex.CallerMemberName}");
            Console.WriteLine($"File Path: {ex.FilePath}");
            Console.WriteLine($"Line: {ex.Line}");
        }
        finally 
        {
#if !DEBUG
            Console.ForegroundColor = color;
            Console.WriteLine();

Console.WriteLine("Press any key to exit");
            Console.ReadKey();
#endif
        }
    }
}

Contributing

Contributions to the Walter.BOM project are welcome! If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!

Support and Contact

If you encounter any problems or have any questions, please contact us via GitHub issues or email (support@vesnx.com). We're here to help.