Merge pull request #3173 from StephenHodgson/vNEXT-BaseDataProviders

Base PR for IMixedRealityDataProviders

Author: keveleigh

Assets/MixedRealityToolkit-Tests/MixedRealityToolkitTests.cs

@@ -50,7 +50,7 @@ public void Test03_CreateMixedRealityToolkit()
 
             // Create Test Configuration
             Assert.AreEqual(0, MixedRealityToolkit.Instance.ActiveProfile.ActiveServices.Count);
-            Assert.AreEqual(0, MixedRealityToolkit.Instance.MixedRealityComponents.Count);
+            Assert.AreEqual(0, MixedRealityToolkit.RegisteredMixedRealityServices.Count);
         }
 
         [Test]
@@ -65,7 +65,7 @@ public void Test04_CreateMixedRealityInputSystem()
             Assert.IsNotNull(MixedRealityToolkit.Instance.ActiveProfile);
             Assert.IsNotEmpty(MixedRealityToolkit.Instance.ActiveProfile.ActiveServices);
             Assert.AreEqual(1, MixedRealityToolkit.Instance.ActiveProfile.ActiveServices.Count);
-            Assert.AreEqual(0, MixedRealityToolkit.Instance.MixedRealityComponents.Count);
+            Assert.AreEqual(0, MixedRealityToolkit.RegisteredMixedRealityServices.Count);
         }
 
         [Test]
@@ -123,7 +123,7 @@ public void Test08_CreateMixedRealityExtensionServices()
             MixedRealityToolkit.Instance.RegisterService(typeof(ITestComponent1), new TestComponent1("Test Component 1", 10));
 
             // Tests
-            Assert.AreEqual(1, MixedRealityToolkit.Instance.MixedRealityComponents.Count);
+            Assert.AreEqual(1, MixedRealityToolkit.RegisteredMixedRealityServices.Count);
         }
 
         [Test]
@@ -156,7 +156,7 @@ public void Test10_TestMixedRealityExtensionServices()
             MixedRealityToolkit.Instance.RegisterService(typeof(ITestComponent1), new TestComponent1("Test Component 1", 10));
             MixedRealityToolkit.Instance.RegisterService(typeof(ITestComponent2), new TestComponent2("Test Component 2", 10));
             MixedRealityToolkit.Instance.RegisterService(typeof(IFailComponent), new TestFailComponent("Fail Component", 10));
-            LogAssert.Expect(LogType.Error, $"Unable to register {typeof(IFailComponent)}. Concrete type does not implement the IMixedRealityExtensionService implementation.");
+            LogAssert.Expect(LogType.Error, $"Unable to register {typeof(IFailComponent)}. Concrete type does not implement IMixedRealityExtensionService or IMixedRealityDataProvider.");
 
             // Retrieve all registered IMixedRealityExtensionServices
             var components = MixedRealityToolkit.Instance.GetActiveServices(typeof(IMixedRealityExtensionService));
@@ -217,7 +217,7 @@ public void Test13_CreateMixedRealityExtensionServiceNameWithInput()
             Assert.IsNotNull(MixedRealityToolkit.Instance.ActiveProfile);
             Assert.IsNotEmpty(MixedRealityToolkit.Instance.ActiveProfile.ActiveServices);
             Assert.AreEqual(1, MixedRealityToolkit.Instance.ActiveProfile.ActiveServices.Count);
-            Assert.AreEqual(2, MixedRealityToolkit.Instance.MixedRealityComponents.Count);
+            Assert.AreEqual(2, MixedRealityToolkit.RegisteredMixedRealityServices.Count);
         }
 
         [Test]
@@ -288,7 +288,7 @@ public void Test16_GetAllMixedRealityExtensionServices()
             MixedRealityToolkit.Instance.RegisterService(typeof(ITestComponent2), new TestComponent2("Test16-2.2", 10));
 
             // Retrieve Component1
-            var allComponents = MixedRealityToolkit.Instance.MixedRealityComponents;
+            var allComponents = MixedRealityToolkit.RegisteredMixedRealityServices;
 
             // Tests
             Assert.AreEqual(4, allComponents.Count);
@@ -371,4 +371,4 @@ public TestFailComponent(string name, uint priority) : base(name, priority) { }
     }
 
     #endregion Test Components
-}
+}

Assets/MixedRealityToolkit/_Core/Definitions/Utilities/SystemType.cs

@@ -38,9 +38,19 @@ public static string GetReference(Type type)
         /// <param name="assemblyQualifiedClassName">Assembly qualified class name.</param>
         public SystemType(string assemblyQualifiedClassName)
         {
-            Type = !string.IsNullOrEmpty(assemblyQualifiedClassName)
-                ? Type.GetType(assemblyQualifiedClassName)
-                : null;
+            if (!string.IsNullOrEmpty(assemblyQualifiedClassName))
+            {
+                Type = Type.GetType(assemblyQualifiedClassName);
+
+                if (Type != null && Type.IsAbstract)
+                {
+                    Type = null;
+                }
+            }
+            else
+            {
+                Type = null;
+            }
         }
 
         /// <summary>
@@ -80,13 +90,13 @@ public Type Type
                 if (value != null)
                 {
 #if WINDOWS_UWP && !ENABLE_IL2CPP
-                    bool isValid = value.IsValueType() && !value.IsEnum() || value.IsClass();
+                    bool isValid = value.IsValueType() && !value.IsEnum() && !value.IsAbstract() || value.IsClass();
 #else
-                    bool isValid = value.IsValueType && !value.IsEnum || value.IsClass;
+                    bool isValid = value.IsValueType && !value.IsEnum && !value.IsAbstract || value.IsClass;
 #endif // WINDOWS_UWP && !ENABLE_IL2CPP
                     if (!isValid)
                     {
-                        Debug.LogError($"'{value.FullName}' is not a class or struct type.");
+                        Debug.LogError($"'{value.FullName}' is not a valid class or struct type.");
                     }
                 }
 

Assets/MixedRealityToolkit/_Core/Inspectors/Profiles/MixedRealityBaseConfigurationProfileInspector.cs

@@ -147,6 +147,7 @@ protected static bool RenderProfile(SerializedProperty property)
             {
                 var renderedProfile = property.objectReferenceValue as BaseMixedRealityProfile;
                 Debug.Assert(renderedProfile != null);
+                Debug.Assert(profile != null, "No profile was set in OnEnable. Did you forget to call base.OnEnable in a derived profile class?");
 
                 if (!renderedProfile.IsCustomProfile && profile.IsCustomProfile)
                 {

Assets/MixedRealityToolkit/_Core/Interfaces/IMixedRealityDataProvider.cs

@@ -0,0 +1,13 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace Microsoft.MixedReality.Toolkit.Core.Interfaces
+{
+    /// <summary>
+    /// Generic interface for all Mixed Reality Data providers
+    /// </summary>
+    public interface IMixedRealityDataProvider : IMixedRealityService
+    {
+        // Reserved for future use.
+    }
+}

Assets/MixedRealityToolkit/_Core/Interfaces/IMixedRealityDataProvider.cs.meta

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using Microsoft.MixedReality.Toolkit.Core.Interfaces;
+
+namespace Microsoft.MixedReality.Toolkit.Core.Services
+{
+    /// <summary>
+    /// The base data provider implements <see cref="IMixedRealityDataProvider"/> and provides default properties for all data providers.
+    /// </summary>
+    /// <remarks>
+    /// Empty, but reserved for future use, in case additional <see cref="IMixedRealityDataProvider"/> properties or methods are assigned.
+    /// </remarks>
+    public abstract class BaseDataProvider : BaseServiceWithConstructor, Interfaces.IMixedRealityDataProvider
+    {
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="name"></param>
+        /// <param name="priority"></param>
+        public BaseDataProvider(string name, uint priority) : base(name, priority) { }
+    }
+}

Assets/MixedRealityToolkit/_Core/Services/BaseDataProvider.cs

@@ -1,32 +1,23 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
+using Microsoft.MixedReality.Toolkit.Core.Interfaces;
+
 namespace Microsoft.MixedReality.Toolkit.Core.Services
 {
     /// <summary>
     /// The base extension service implements <see cref="Interfaces.IMixedRealityExtensionService"/> and provides default properties for all extension services.
     /// </summary>
-    public class BaseExtensionService : BaseService, Interfaces.IMixedRealityExtensionService
+    /// <remarks>
+    /// Empty, but reserved for future use, in case additional <see cref="IMixedRealityExtensionService"/> properties or methods are assigned.
+    /// </remarks>
+    public abstract class BaseExtensionService : BaseServiceWithConstructor, Interfaces.IMixedRealityExtensionService
     {
         /// <summary>
         /// Constructor.
         /// </summary>
         /// <param name="name"></param>
         /// <param name="priority"></param>
-        public BaseExtensionService(string name, uint priority)
-        {
-            this.name = name;
-            this.priority = priority;
-        }
-
-        private readonly string name;
-
-        /// <inheritdoc />
-        public override string Name => name;
-
-        private readonly uint priority;
-
-        /// <inheritdoc />
-        public override uint Priority => priority;
+        public BaseExtensionService(string name, uint priority) : base(name, priority) { }
     }
 }

Assets/MixedRealityToolkit/_Core/Services/BaseDataProvider.cs.meta

@@ -6,7 +6,7 @@ namespace Microsoft.MixedReality.Toolkit.Core.Services
     /// <summary>
     /// The base service implements <see cref="Interfaces.IMixedRealityService"/> and provides default properties for all services.
     /// </summary>
-    public class BaseService : Interfaces.IMixedRealityService
+    public abstract class BaseService : Interfaces.IMixedRealityService
     {
         /// <inheritdoc />
         public virtual string Name { get; protected set; }