Refactor

Author: spydaz

Emotion_Handler.vb

@@ -3,6 +3,9 @@
     ''' Current emotion
     ''' </summary>
     Public CurrentState As EmotionType
+    ''' <summary>
+    ''' Current emotion as STRING
+    ''' </summary>
     Public CurrentStateStr As String = "Neutral"
     ''' <summary>
     ''' If state has changed mood has changed
@@ -17,17 +20,19 @@
     ''' </summary>
     Private StateDetected As Boolean = False
     ''' <summary>
-    ''' Intensity of emotion increases if emotional state remains the same
+    ''' Intensity of emotion increases if emotional state remains the same and is reduced if At JOY 3 and state is detected Neutral is reduced
+    ''' Intensity can rise and fall eventually becomming neutral - Even neutrality and indifference can be intesified: 
+    ''' Perhaps if neutrality reaches a certain point then BORDEM can SET IN!
     ''' </summary>
-    Public CurrentQuotient As Integer = 0
+    Public CurrentQuotient As Integer = 1
     'PROCESS: PRESERVE VARIABLES
     'EMOTION
     ''' <summary>
     ''' Used to make a Generic Emotional Response 
     ''' </summary>
     ''' <param name="FoundEmotion">Provided emotion (HAPPY)</param>
     ''' <returns></returns>
-    Public Function MakeEmotionalResponse(ByVal FoundEmotion As String) As String
+    Public Shared Function MakeEmotionalResponse(ByVal FoundEmotion As String) As String
         MakeEmotionalResponse = ""
         Randomize()
         Dim C As Short = Int(Rnd() * 6 + 1)
@@ -70,47 +75,68 @@
                 MakeEmotionalResponse = "" & LCase(FoundEmotion) & " "
         End Select
     End Function
-
+    ''' <summary>
+    ''' Resets Indicator values for determining state change
+    ''' </summary>
     Private Sub ResetStateCounters()
         'Reset Counters
         StateChanged = False
         DetectedState = EmotionType.Neutral
         StateDetected = False
     End Sub
+    ''' <summary>
+    ''' Increases or Decreases current intensity of emotion held
+    ''' </summary>
     Private Sub SetCurrentQuotient()
         'Check if neutral - Then reduce current Quotient
         If Handler.DetectedEmotion = EmotionType.Neutral Then
             CurrentQuotient -= 1
             If CurrentQuotient = 0 Then
+                'Reset State
                 CurrentState = EmotionType.Neutral
+                CurrentStateStr = "Neutral"
+                StateChanged = True
             Else
             End If
         End If
     End Sub
-
+    ''' <summary>
+    ''' Shared between functions holding the currently detected emotions and Created intefaces(STATES)
+    ''' </summary>
     Private Handler As New EmotionHandler
-
+    ''' <summary>
+    ''' Determines and sets the current state and intensity of state: 
+    ''' The Quotient value can be used to determine how much of a particular emotion is experienced, 
+    ''' the value is increased as emotion is repeatly detected.
+    ''' as the conversation returns to neutrality if another emotion is ot detected the Qujotient is decreased
+    ''' At point of 0 intensity the state is returned to Neutral
+    ''' </summary>
+    ''' <param name="UserInput"></param>
     Private Sub SetEmotionState(ByRef UserInput As String)
+        'Reset the indicators for Detected ans State Change
         ResetStateCounters()
 
         'Start - Emotion Test
         If Handler.DetectEmotion(UserInput) = True Then
-
+            'Updates Quotient If No Changes have been Detected +/- (intensity of emotion)
             SetCurrentQuotient()
 
             'Get State
             DetectedState = Handler.DetectedEmotion
             StateDetected = True
+
             'IF State is the same Increase Intensity
             If DetectedState = CurrentState Then
                 CurrentQuotient += 1
+                'Update State "DATA" 
                 CurrentStateStr = Handler.DetectedEmotionStr
                 CurrentState = DetectedState
             Else
-                'IF State is the differnt then change
+                'IF State is the differnt then change (Update State Data)
                 CurrentStateStr = Handler.DetectedEmotionStr
                 CurrentState = DetectedState
                 StateChanged = True
+                'Reset Intensity
                 CurrentQuotient = 1
             End If
         End If
@@ -140,7 +166,7 @@ End Class
 ''' </summary>
 Public Class EmotionHandler
 
-    Private iLoadedEmotions As New List(Of Emotion)
+    Private iLoadedEmotions As New List(Of IEmotion)
 
     Private mDetectedEmotion As EmotionType
 
@@ -159,7 +185,7 @@ Public Class EmotionHandler
 
     End Property
 
-    Public ReadOnly Property LoadedEmotions As List(Of Emotion)
+    Public ReadOnly Property LoadedEmotions As List(Of IEmotion)
         Get
             Return iLoadedEmotions
         End Get
@@ -169,12 +195,12 @@ Public Class EmotionHandler
         iLoadedEmotions = LoadEmotions()
     End Sub
 
-    Public Sub AddEmotion(ByRef Emo As Emotion)
+    Public Sub AddEmotion(ByRef Emo As IEmotion)
         iLoadedEmotions.Add(Emo)
     End Sub
 
     Public Function DetectEmotion(ByRef Userinput As String) As Boolean
-        For Each emo As Emotion In LoadedEmotions
+        For Each emo As IEmotion In LoadedEmotions
             If emo.Detect(Userinput) = True Then
                 mDetectedEmotion = emo.Type
                 mEmotion = emo.Name
@@ -189,8 +215,8 @@ Public Class EmotionHandler
         Return False
     End Function
 
-    Public Function LoadEmotions() As List(Of Emotion)
-        Dim mLoadedEMOTIONs As New List(Of Emotion) From {
+    Public Function LoadEmotions() As List(Of IEmotion)
+        Dim mLoadedEMOTIONs As New List(Of IEmotion) From {
                     New EmotionAngry,
                     New EmotionConcerned,
                     New EmotionCurious,