RtcBase.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System;

namespace Iot.Device.Rtc
{
    /// <summary>
    /// Real time clock (RTC).
    /// </summary>
    public abstract class RtcBase : IDisposable
    {
        /// <summary>
        /// Gets or sets the device's <see cref="System.DateTime"/>
        /// </summary>
        public virtual DateTime DateTime
        {
            get => ReadTime();
            set => SetTime(value);
        }

        /// <summary>
        /// Set the device time.
        /// </summary>
        /// <param name="time">Time.</param>
        protected abstract void SetTime(DateTime time);

        /// <summary>
        /// Read time from the device.
        /// </summary>
        /// <returns>Time from the device.</returns>
        protected abstract DateTime ReadTime();

        /// <inheritdoc/>
        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        /// <summary>
        /// Releases the unmanaged resources used by the RtcBase and optionally releases the managed resources.
        /// </summary>
        /// <param name="disposing">True to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
        protected virtual void Dispose(bool disposing)
        {
        }
    }
}