Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Breaking changes/mid revision #102

Merged
merged 35 commits into from
May 31, 2023
Merged

Breaking changes/mid revision #102

merged 35 commits into from
May 31, 2023

Conversation

Rickedb
Copy link
Owner

@Rickedb Rickedb commented May 31, 2023

Breaking changes

  • Default revision is always Revision 1, using the last revision is not normal and it would cause many breaking changes as well
  • revision optional parameter of MIDs constructors is no longer optional since the default is always 1, if a revision is desired you should pass it as parameter
  • Validate() method that existed in some Mids were removed.
  • Constructors that fill properties are no longer available, it will only define header parameters, all the datafield must be set directly.
  • All Datafields enum are now protected, since it belongs only to the mid itself, you should not use externally.
  • Removed inner PowerMacsStatuses enum from Mid0107 and now uses the PowerMacsStatus enum
  • All enums format were updated to PascalCase and not SNAKE_CASE (however - characters are interpreted as _)
  • Moved OpenEndData class outside of Mid0041
  • ToolType enum changed accordingly with documentation, IPT refers to code 30 in place of QSHIELD_C
  • Converters and IValueConverter<T> was removed and converted to static functions at OpenProtocolConvert or a protected virtual method at the unique mid that needs it
  • PaddingOrientations enum is no longer inside DataField class and changed to PaddingOrientation

Improvements

  • Project now targets .net standard 2.0 and the latest LTS version .NET 6
  • Enforce padding to specified size if truncated
  • Revision by field are now null safe

New Features

  • Added Mid0009
  • Added Mid0702
  • Added Mid0703
  • Added Mid2505
  • Added PIDs' enums in categories
  • Updated AutoSelect enum
  • Updated JobTighteningStatus enum
  • Updated ResultType enum
  • Updated SystemType enum

Fixes

Related issues

@Rickedb Rickedb merged commit 9799caa into master May 31, 2023
@Rickedb Rickedb deleted the breaking-changes/mid-revision branch December 11, 2023 01:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant