Click or drag to resize

Solution Class

A solution.
Inheritance Hierarchy
SystemObject
  SRS.ShiftSolver.CoreSolution

Namespace:  SRS.ShiftSolver.Core
Assembly:  ShiftSolver (in ShiftSolver.dll) Version: 2.2.0.0
Syntax
public class Solution

The Solution type exposes the following members.

Properties
  NameDescription
Public propertyEmployeesPenalty
The sum of the penalties for the employees' individual schedules. For example, soft constraints related to shift start times and shift lengths, minimum working hours etc.
Public propertyLocalOptimum
If the solution is a local optimum it means that the solution cannot be easily improved by making changes such as swapping shifts or adjusting start and/or end times for example. The solver contains procedures which check for these basic improvements. If this flag is true then it means the solution has had all of these procedures applied to it and it should not be able to improve the solution using simple manual procedures. If the flag is false then it may still be locally optimal but it cannot be guaranteed locally optimal because all the procedures have not been applied due to not enough solving time.
Public propertyOtherPenalty
The total penalty for soft constraints not related to employees' individual schedules. For example, the cover constraints.
Public propertyPenalty
The total penalty due to all soft constraint violations in this solution.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEmployees
Returns the IDs of all the employees in the problem.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetOtherViolations
Returns the violations for constraints which are not specific to individual employees. For example, cover constraint violations.
Public methodGetTotalCoverRequiredTime
Returns the total minimum/maximum time for the Cover constraints with the specified ID.
Public methodGetTotalCoverViolationTime
Returns the total amount of time assigned above the maximum or below the minimum Cover constraints with the specified ID.
Public methodGetTotalScheduledWorkTime
Returns the total amount of time scheduled to all employees. If a break has a 'WorkLength' different to the actual physical length of the break then the break's 'WorkLength' is used rather than the actual physical length. For example, if a break has a WorkLength of zero then that time will not be included.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViolationsForEmployee
Returns the constraint violations related to an individual employee's schedule. These are the constraints in their contract and day and shift on/off requests.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToXml
Gets the solution in an XML format.
Top
See Also

www.staffrostersolutions.com | support