Feature/maintenance-scheduler

[MathoMathiasCamara]

Summary

This PR adds the maintenance scheduler API, endpoints and UI from MORYX 8 (gitlab) to MORYX 10.

For those who don't know about this module. Here is a quick recap:

Maintenance Scheduler API:

This module allows the scheduling of maintenance for machines in the manufacturing factory.

Concepts :

• Maintenance Order: Is an order/command sent to the machine to execute a maintenance.
• Acknowledgement: Is a confirmation sent by a machine to indicate that the maintenance was performed.
• Maintenance Schedule: This is a schedule from which a Maintenance Order is generated.

IMaintenanceManagement :

This is the facade through which other module or service can interact with the Maintenance Scheduler The facade contains:

• AddMaintenanceOrder()
• AcknowledgeMaintenanceOrder()
• UpdateMaintenanceOrder()
• DeleteMaintenanceOrder()

These functions/methods allow you to create,edit and delete a maintenance order. It also contains events :

- MaintenanceOrderAdded
- MaintenanceOrderUpdated
- MaintenanceOrderAcknowledged
- MaintenanceOrderSent
- MaintenanceOverdue
- MaintenanceStarted

These events are used to notify subscibers of any important actions or events that happens in the Maintenance Scheduler.

IMaintainableResource

An IMaintainableResource is a machine that can receive a maintenance order/command. Every machine that implements this interface are tracked by the Maintenance Scheduler. It contains the StartMaintenance method which is invoked when a maintenance should be performed on the machine. It also contains events such as:

• CycleChanged
• MaintenanceCompleted
• MaintenanceStarted

There events are raised by the machine to notify the IMaintenanceManagement.

Preview:

Breaking Changes

Checklist for Submitter

• I have tested these changes locally
• I have updated documentation as needed
• I have added or updated tests as appropriate
• I have used clear and descriptive commit messages

Review

Typical tasks

• Merge request is well described
• Critical sections are documented in code
• Tests are extended
• Documentation is created / updated
• Running in test environment
• Ports to other maintained versions are created

Clean code

• All unused references are removed
• Clean code rules are respected with passion (naming, ...)
• Avoid copy and pasted code snippets

[dbeuchler]

I have done a really short review and found a lot of code issues that were removed from all modules in MORYX 10. Before this is merged, this should definitely be cleaned up. All new patterns that we have applied to other modules should also be applied here. Tests and documentation is completely missing. Nondescriptive PR title / description

[MathoMathiasCamara]

The unit test and documentation will be added in the future. an issue has already been created for that.