Documentation modifications
This commit is contained in:
@@ -51,6 +51,28 @@ public class AlarmService : IAlarmService
|
||||
|
||||
private TimeSpan _interval;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="AlarmService"/> class, injecting required dependencies for alarm processing and optionally starting the internal alarm timer when <paramref name="startTimer"/> is <see langword="true"/>.
|
||||
/// </summary>
|
||||
/// <param name="alarmRepository">The <see cref="IAlarmRepository"/> used to persist and retrieve alarm data.</param>
|
||||
/// <param name="logger">The <see cref="ILogger{AlarmService}"/> used for diagnostic logging.</param>
|
||||
/// <param name="patientService">The <see cref="IPatientService"/> used to access patient information.</param>
|
||||
/// <param name="configObservationService">The <see cref="IConfigObservationService"/> used to retrieve observation configuration.</param>
|
||||
/// <param name="observationService">A <see cref="Lazy{IObservationService}"/> providing deferred access to observation data.</param>
|
||||
/// <param name="clientMessageService">The <see cref="IClientMessageService"/> used to publish client notifications.</param>
|
||||
/// <param name="subscribersService">The <see cref="ISubscribersService"/> used to manage alarm subscribers.</param>
|
||||
/// <param name="calculatedObservationsService">A <see cref="Lazy{ICalculatedObservationsService}"/> providing deferred access to calculated observations.</param>
|
||||
/// <param name="lightBeaconService">A <see cref="Lazy{ILightBeaconService}"/> providing deferred access to the light beacon service.</param>
|
||||
/// <param name="recordingService">A <see cref="Lazy{IRecordingService}"/> providing deferred access to the recording service.</param>
|
||||
/// <param name="relayService">A <see cref="Lazy{IRelayService}"/> providing deferred access to the relay service.</param>
|
||||
/// <param name="apiSettings">The <see cref="IOptions{ApiSettings}"/> providing access to API configuration.</param>
|
||||
/// <param name="unitService">The <see cref="IUnitService"/> used to manage unit information.</param>
|
||||
/// <param name="pocService">The <see cref="IPointOfCareService"/> used to access point-of-care information.</param>
|
||||
/// <param name="httpContextAccessor">The <see cref="IHttpContextAccessor"/> used to access the current HTTP context.</param>
|
||||
/// <param name="auditService">The <see cref="ILocalAuditService"/> used to record audit entries.</param>
|
||||
/// <param name="startTimer">A <see cref="bool"/> indicating whether the alarm timer should be started during construction.</param>
|
||||
/// <exception cref="System.Exception">Thrown when <paramref name="apiSettings"/> is <see langword="null"/>.</exception>
|
||||
/// <!-- aidoc:v1 sig=15ef9b7 body=6126462 -->
|
||||
public AlarmService(IAlarmRepository alarmRepository,
|
||||
ILogger<AlarmService> logger,
|
||||
IPatientService patientService,
|
||||
|
||||
Reference in New Issue
Block a user