server
server copied to clipboard
Freezor/ AasxServer.Program.cs: Clear the bodies from the street and extinguish fires
Description
This pull request aims to clean up an excessively messy class by applying common naming strategies, best practices for naming and structure, and removing redundant code. The commit messages detail the specific changes made to improve the code's readability and maintainability.
Motivation and Context
The motivation behind this change is to address the challenges posed by the overly complicated and poorly structured code. By cleaning up the class, we aim to make it more understandable and maintainable, reducing cognitive overload for developers who need to work with it.
Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [x] This change requires a documentation update
How Has This Been Tested?
The changes have been tested by reviewing the modified code and verifying that it adheres to the common naming conventions and best practices. Additionally, the changes have been reviewed by team members for feedback and validation.
Screenshots (if appropriate):
Checklist:
- [x] My code follows the style guidelines of this project
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works -> NO! Needs bigger refactoring to even start testing. But that is my ultimate goal
Full list of changes, based on changelog
Changed
- Renamed AasxServer.Program.signalNewData to Program.SignalNewData (@Freezor)
- Renamed AasxServer.Program.NewDataAvailableArgs to Program.NewDataAvailableEventArgs, in order to apply common naming scheme for EventArgs classes (@Freezor)
- Renamed AasxServer.Program.getDataVersion to Program.GetDataVersion (@Freezor)
- Renamed AasxServer.Program.con to Program.Configuration (@Freezor)
- Renamed AasxServer.Program.saveEnv to Program.SaveEnvironment (@Freezor)
- Renamed AasxServer.Program.loadPackageForAas to Program.LoadPackageForAas (@Freezor)
- Renamed AasxServer.Program.loadPackageForSubmodel to Program.LoadPackageForSubmodel (@Freezor)
- Renamed AasxServer.Program.parseJson to Program.ParseJson (@Freezor)
- Renamed AasxServer.Program.changeDataVersion to Program.ChangeDataVersion (@Freezor)
- Renamed AasxServer.Program.creatAASDescriptor to Program.CreateAASDescriptor (@Freezor)
- Renamed AasxServer.Program.publishDescriptorData to Program.PublishDescriptorData (@Freezor)
- Renamed AasxServer.Program.connectThreadLoop to Program.ConnectThreadLoop (@Freezor)
- Renamed AasxServer.Program.getDataVersion to Program.GetDataVersion (@Freezor)
- Renamed AasxServer.aasDirectoryParameters to AasDirectoryParameters (@Freezor)
Removed
- Unused methods in AasxServer.Program: GetBetween, createDbFiles, OnRestTimedEvent (@Freezor)