Added application startup logging for ViewModel and Device Manager classes

Author: astroman133

DeviceHub/App.config

@@ -19,6 +19,9 @@
             <setting name="ServerLoggingEnabled" serializeAs="String">
                 <value>False</value>
             </setting>
+            <setting name="DeviceHubAppLoggingEnabled" serializeAs="String">
+                <value>False</value>
+            </setting>
         </ASCOM.DeviceHub.Properties.Settings>
     </applicationSettings>
 </configuration>

DeviceHub/Business Object Classes/ASCOM Classes/LocalServer.cs

@@ -1084,11 +1084,16 @@ private static bool ProcessArguments( string[] args )
 						retval = false;
 
 						break;
+					case "-enableapplogging":
+					case @"/enableapplogging":
+						Logger.LogMessage( msgId, "Enabling application startup logging." );
+						Globals.ForceAppLogging = true;
+						break;
 
 					default:
 						string msg = $"Unknown argument: {args[0]}";
 						Logger.LogMessage( msgId, msg );
-						msg += "\nValid are : -register, -unregister, unregister_full, and -embedding";
+						msg += "\nValid are : -register, -unregister, unregister_full, -embedding, and -enableapplogging";
 						string caption = GetAssemblyTitle();
 						MessageBox.Show( msg, caption, MessageBoxButton.OK, MessageBoxImage.Exclamation );
 

DeviceHub/Business Object Classes/Globals.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Threading.Tasks;
 
+using ASCOM.Utilities;
+
 namespace ASCOM.DeviceHub
 {
 	public static class Globals
@@ -17,10 +19,10 @@ static Globals()
 		public const double DegRad = Math.PI / 180.0;
 		public const double UTC_SECS_PER_SIDEREAL_SEC = 0.9972695677;
 
-		public const double DEG_TO_RAD = ( 2.0 * Math.PI ) / 360.0;		// 0.017453 radians per degree
-		public const double RAD_TO_DEG = 1.0 / DEG_TO_RAD;				// 57.29578 degrees per radian
-		public const double HRS_TO_RAD = ( 2.0 * Math.PI ) / 24.0;		// 0.26180 radians per hour
-		public const double RAD_TO_HRS = 1.0 / HRS_TO_RAD;				// 3.81972 hours per radian
+		public const double DEG_TO_RAD = ( 2.0 * Math.PI ) / 360.0;     // 0.017453 radians per degree
+		public const double RAD_TO_DEG = 1.0 / DEG_TO_RAD;              // 57.29578 degrees per radian
+		public const double HRS_TO_RAD = ( 2.0 * Math.PI ) / 24.0;      // 0.26180 radians per hour
+		public const double RAD_TO_HRS = 1.0 / HRS_TO_RAD;              // 3.81972 hours per radian
 		public const double HRS_TO_DEG = 15.0;                          // 15 degrees per hour
 
 		public const double SCOPE_FAST_UPDATE_MIN = 0.5;
@@ -67,5 +69,26 @@ static Globals()
 		public static DevHubTelescopeStatus LatestRawTelescopeStatus { get; set; }
 
 		public static TaskScheduler UISyncContext { get; set; }
+
+		public static bool ForceAppLogging { get; set; }
+
+		private static TraceLogger _appLogger = null;
+
+		public static TraceLogger AppLogger 
+		{ 
+			get
+			{
+				if ( _appLogger == null )
+				{
+					_appLogger = new Utilities.TraceLogger( "", "DeviceHub.App" )
+					{
+						Enabled = Properties.Settings.Default.DeviceHubAppLoggingEnabled || ForceAppLogging,
+						IdentifierWidth = 50
+					};
+				}
+
+				return _appLogger;
+			}
+		}
 	}
 }

DeviceHub/DeviceManagers/DeviceManagerBase.cs

@@ -32,12 +32,18 @@ public class DeviceManagerBase : NormalizedValueBase, INotifyPropertyChanged
 
 		public DeviceManagerBase( DeviceTypeEnum deviceType )
 		{
+			string caller = $"DeviceManagerBase ctor for {deviceType}";
+
+			LogAppMessage( "Initializing Instance constructor", caller );
+
 			DeviceType = deviceType;
 
 			ThrowOnInvalidPropertyName = false;
 			_messageBoxService = null;
 
 			Exceptions = new PropertyExceptions();
+
+			LogAppMessage( "Instance constructor initialization complete.", caller );
 		}
 
 		public Exception GetLastPropertyException( [System.Runtime.CompilerServices.CallerMemberName] string propName = "???" )
@@ -311,6 +317,15 @@ private string GetMessageTypeName( ActivityMessageTypes msgType )
 
 		#endregion
 
+		#region Application Logging Methods
+
+		protected static void LogAppMessage( string message, [System.Runtime.CompilerServices.CallerMemberName] string callerName = "???" )
+		{
+			Globals.AppLogger.LogMessage( callerName, message );
+		}
+
+		#endregion Application Logging Methods
+
 		#region Message Box Support Members
 
 		private IMessageBoxService _messageBoxService;

DeviceHub/DeviceManagers/DomeManager.cs

@@ -39,6 +39,10 @@ public static DomeManager Instance
 
 		static DomeManager()
 		{
+			string caller = "DomeManager static ctor";
+
+			LogAppMessage( "Initialization started", caller );
+
 			DomeID = "";
 		}
 
@@ -74,6 +78,10 @@ public static void SetDomeID( string id )
 		private DomeManager()
 			: base( DeviceTypeEnum.Dome )
 		{
+			string caller = "DomeManager instance ctor";
+
+			LogAppMessage( "Initializing Instance constructor", caller );
+
 			IsConnected = false;
 			Capabilities = null;
 			Parameters = null;
@@ -88,10 +96,14 @@ private DomeManager()
 			PollingPeriod = POLLING_INTERVAL_NORMAL;
 			PollingChange = new ManualResetEvent( false );
 
+			LogAppMessage( "Registering message handlers.", caller );
+
 			Messenger.Default.Register<TelescopeParametersUpdatedMessage>( this, ( action ) => UpdateTelescopeParameters( action ) );
 			Messenger.Default.Register<TelescopeStatusUpdatedMessage>( this, ( action ) => UpdateTelescopeStatus( action ) );
 			Messenger.Default.Register<DeviceDisconnectedMessage>( this, ( action ) => ClearTelescopeStatus( action ) );
 			Messenger.Default.Register<SlewInProgressMessage>( this, ( action ) => InitiateSlavedSlew( action ) );
+
+			LogAppMessage( "Instance constructor initialization complete.", caller );
 		}
 
 		#endregion Instance Constructor

DeviceHub/DeviceManagers/FocuserManager.cs

@@ -34,7 +34,11 @@ public static FocuserManager Instance
 
 		static FocuserManager()
 		{
+			string caller = "FocuserManager static ctor";
+
+			LogAppMessage( "Initialization started.", caller );
 			FocuserID = "";
+			LogAppMessage( "Initialization completed.", caller );
 		}
 
 		public static void SetFocuserID( string id )
@@ -63,6 +67,9 @@ public static void SetFocuserID( string id )
 		public FocuserManager()
 				: base( DeviceTypeEnum.Focuser )
 		{
+			string caller = "FocuserManager instance ctor";
+			LogAppMessage( "Initializing Instance constructor", caller );
+
 			IsConnected = false;
 			Parameters = null;
 			Status = null;
@@ -71,6 +78,8 @@ public FocuserManager()
 			MoveInProgress = false;
 			PollingPeriod = POLLING_PERIOD_NORMAL;
 			PollingChange = new ManualResetEvent( false );
+
+			LogAppMessage( "Instance constructor initialization complete.", caller );
 		}
 
 		#endregion Instance Constructor

DeviceHub/DeviceManagers/TelescopeManager.cs

@@ -43,9 +43,23 @@ public static TelescopeManager Instance
 
 		static TelescopeManager()
 		{
+			string caller = "TelescopeManager static ctor";
 			TelescopeID = "";
+			LogAppMessage( "Initialization started.", caller );
 
-			AstroUtils = new AstroUtils();
+			try
+			{
+				LogAppMessage( "Creating AstroUtils instance", caller );
+
+				AstroUtils = new AstroUtils();
+			}
+			catch (Exception xcp)
+			{
+				string msg = $"Unable to create an instance of AstroUtils. Details follow:\r\n\r\n{xcp}";
+				LogAppMessage( msg, "TelescopeManager static constructor" );
+			}
+
+			LogAppMessage( "Initialization complete", caller );
 		}
 
 		public static void SetTelescopeID( string id )
@@ -93,6 +107,9 @@ private DateTime PulseGuideEnd
 		private TelescopeManager()
 			: base( DeviceTypeEnum.Telescope )
 		{
+			string caller = "TelescopeManager instance ctor";
+			LogAppMessage( "Initializing Instance constructor", caller );
+
 			IsConnected = false;
 			Capabilities = null;
 			Parameters = null;
@@ -105,6 +122,8 @@ private TelescopeManager()
 			PollingChange = new ManualResetEvent( false );
 
 			PreviousSlewInProgressMessage = new SlewInProgressMessage( false );
+
+			LogAppMessage( "Instance constructor initialization complete.", caller );
 		}
 
 		#endregion Instance Constructor

DeviceHub/Properties/Settings.Designer.cs

@@ -11,5 +11,8 @@
     <Setting Name="ServerLoggingEnabled" Type="System.Boolean" Scope="Application">
       <Value Profile="(Default)">False</Value>
     </Setting>
+    <Setting Name="DeviceHubAppLoggingEnabled" Type="System.Boolean" Scope="Application">
+      <Value Profile="(Default)">False</Value>
+    </Setting>
   </Settings>
 </SettingsFile>

DeviceHub/Properties/Settings.settings

@@ -67,6 +67,15 @@ protected MessageBoxResult ShowMessage( string text, string caption, MessageBoxB
 
 		#endregion MessageBox Helpers
 
+		#region App Logger Members
+
+		protected static void LogAppMessage( string message, [System.Runtime.CompilerServices.CallerMemberName] string callerName = "???" )
+		{
+			Globals.AppLogger.LogMessage( callerName, message );
+		}
+
+		#endregion App Logger Members
+
 		#region INotifyPropertyChanged Members
 
 		/// <summary>