Roster Class |
A solution to the rostering problem.
Inheritance HierarchyNamespace: ASAP.NRP.Core
Assembly: NRP (in NRP.dll) Version: 3.49.0+539d3dcf73518163e952c8abb92256bf56ba5029
SyntaxThe Roster type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Penalty |
Gets the total penalty due to soft constraint violations in this roster.
|
| TotalPenalty | Obsolete.
This has been left in for backwards compatibility and decimal values are rounded upwards.
Instead use Roster.Penalty (which is a double).
|
Methods| Name | Description | |
|---|---|---|
 | AssignShift |
Assigns a shift to an employee.
|
| Clone |
Makes a copy of the Roster.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAssignmentsXml |
Gets the XML for all the shift assignments.
|
| GetEmployeeViolationXml |
Gets the violation XML for an employee.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetOtherViolationsXml |
Gets the violation XML for cover constraints, rule constraints
and employee pairing constraints.
|
| GetPenaltyForShiftCover |
Gets the cover penalty due to a particular shift type
for all skills (or skill groups).
|
| GetPenaltyForShiftTypeCover | Obsolete.
This has been left in for backwards compatibility and
decimal values are rounded upwards.
Use GetPenaltyForShiftCover instead (which returns a double).
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUpdatedEmployees |
Returns a list of employees linked to constraints that may have
been effected by any changes in the solution since the last penalty/violation
calculations.
|
| IsFeasible |
Returns false if any hard constraints are violated, true otherwise.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RecalculatePenaltyAndViolations |
Recalculates the roster's penalty and violations.
|
| SortEmployeesByName |
Sorts the employees alphabetically by their label.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToXml(Boolean) |
Gets the solution in an XML format.
|
| ToXml(Boolean, Boolean) |
Gets the XML for the solution.
|
| UnAssignShift |
Un-assigns a shift.
|
Fields| Name | Description | |
|---|---|---|
 | SchedulingPeriod |
The SchedulingPeriod for this roster.
|
| VarValues |
Values of variables referenced in rules.
|
See Also