New feature: DSS Visualization Tool support. Includes new plot commands, TCP/IP communication and JSON format for message exchange.

git-svn-id: svn://svn.code.sf.net/p/electricdss/code/trunk@2093 d8739450-1e93-4ef4-a0af-c327d92816ff

Author: miguelh

Source/Common/DSSGlobals.pas

@@ -21,7 +21,7 @@
 interface
 
 Uses Classes, DSSClassDefs, DSSObject, DSSClass, ParserDel, Hashlist, PointerList,
-     UComplex, Arraydef, CktElement, Circuit, IniRegSave, {$IFNDEF FPC}Graphics,{$ENDIF}
+     UComplex, Arraydef, CktElement, Circuit, IniRegSave, {$IFNDEF FPC}Graphics,{$ENDIF} System.IOUtils, inifiles,
 
      {Some units which have global vars defined here}
      Spectrum,
@@ -109,7 +109,12 @@ interface
    DLLDebugFile   :TextFile;
    ProgramName    :String;
    DSS_Registry   :TIniRegSave; // Registry   (See Executive)
-   
+
+   // Global variables for the DSS visualization tool
+   DSS_Viz_installed   :Boolean=False; // DSS visualization tool (flag of existance)
+   DSS_Viz_path: String;
+   DSS_Viz_enable: Boolean=False;
+
    IsDLL,
    NoFormsAllowed  :Boolean;
 
@@ -772,6 +777,39 @@ function IsDirectoryWritable(const Dir: String): Boolean;
      ReallocMem(p, newsize);
 End;
 
+// Advance visualization tool check
+function GetIni(s,k: string; d: string; f: string=''): string; overload;
+var
+  ini: TMemIniFile;
+begin
+  Result := d;
+  if f = '' then
+  begin
+    ini := TMemIniFile.Create(lowercase(ChangeFileExt(ParamStr(0),'.ini')));
+  end
+  else
+  begin
+    if not FileExists(f) then Exit;
+    ini := TMemIniFile.Create(f);
+  end;
+  if ini.ReadString(s,k,'') = '' then
+  begin
+    ini.WriteString(s,k,d);
+    ini.UpdateFile;
+  end;
+  Result := ini.ReadString(s,k,d);
+  FreeAndNil(ini);
+end;
+
+function CheckDSSVisualizationTool: Boolean;
+begin
+  DSS_Viz_path:=GetIni('Application','path','', TPath.GetHomePath+'\OpenDSS Visualization Tool\settings.ini');
+  Result:=true;
+  if DSS_Viz_path='' then
+    Result:=false;
+end;
+// End of visualization tool check
+
 initialization
 
    {Various Constants and Switches}
@@ -881,6 +919,8 @@ initialization
 
    //WriteDLLDebugFile('DSSGlobals');
 
+   DSS_Viz_installed:= CheckDSSVisualizationTool; // DSS visualization tool (flag of existance)
+
 Finalization
 
   // Dosimplemsg('Enter DSSGlobals Unit Finalization.');

Source/Executive/ConnectOptions.pas

@@ -0,0 +1,90 @@
+unit ConnectOptions;
+{
+  ----------------------------------------------------------
+  Copyright (c) 2008-2017, Electric Power Research Institute, Inc.
+  All rights reserved.
+  ----------------------------------------------------------
+}
+
+interface
+
+Uses Command;
+
+CONST
+        NumConnectOptions = 2;
+
+FUNCTION DoConnectCmd:Integer;
+FUNCTION DoDisConnectCmd:Integer;
+
+Var
+         ConnectOption,
+         ConnectHelp :Array[1..NumConnectOptions] of String;
+         ConnectCommands:TCommandList;
+
+implementation
+
+Uses TCP_IP, DSSGlobals, SysUtils, ParserDel, Utilities;
+
+
+PROCEDURE DefineOptions;
+Begin
+      ConnectOption[ 1] := 'address';
+      ConnectOption[ 2] := 'port';
+
+      ConnectHelp[ 1] := 'Address is a string containing the IP address of a particular system with which OpenDSS should form a connection';
+      ConnectHelp[ 2] := 'Port is the ID of the desired server connection:'+ CRLF +
+                      '47625 = DSS Visualization Tool';
+End;
+
+FUNCTION DoConnectCmd:Integer;
+//Var
+//   ParamName, Param:String;
+//   ParamPointer, i:Integer;
+Begin
+  Result := 0;
+//    If NoFormsAllowed Then Begin Result :=1; Exit; End;
+  If Not Assigned(DSSConnectObj) Then DSSConnectObj := TDSSConnect.Create;
+  DSSConnectObj.SetDefaults;
+  With DSSConnectObj Do Begin
+    Connect;
+  End;
+End;
+
+FUNCTION DoDisConnectCmd:Integer;
+//Var
+//  ParamName, Param:String;
+//  ParamPointer, i:Integer;
+Begin
+  Result := 0;
+//    If NoFormsAllowed Then Begin Result :=1; Exit; End;
+  If Assigned(DSSConnectObj) Then
+  begin
+    With DSSConnectObj Do Begin
+      Disconnect;
+    End;
+  end;
+End;
+
+
+Procedure DisposeStrings;
+Var i:Integer;
+
+Begin
+    For i := 1 to NumConnectOptions Do Begin
+       ConnectOption[i] := '';
+       ConnectHelp[i]   := '';
+   End;
+
+End;
+
+
+Initialization
+    DefineOptions;
+    ConnectCommands := TCommandList.Create(ConnectOption);
+    ConnectCommands.Abbrev := True;
+
+Finalization
+    DoDisConnectCmd;
+    DisposeStrings;
+    ConnectCommands.Free;
+end.

Source/Executive/ExecCommands.pas

@@ -11,7 +11,7 @@ interface
 Uses Command;
 
 CONST
-     NumExecCommands = 104;
+     NumExecCommands = 106;
 
 Var
 
@@ -28,7 +28,7 @@ interface
 implementation
 
 Uses DSSGlobals, ExecHelper, Executive, ExecOptions, ShowOptions,
-     ExportOptions, ParserDel, LoadShape,
+     ExportOptions, ConnectOptions, ParserDel, LoadShape,
      {$IFDEF FPC} CmdForms,{$ELSE} PlotOptions, DSSForms,{$ENDIF}
      sysutils, Utilities, SolutionAlgs;
 
@@ -142,6 +142,8 @@ implementation
      ExecCommand[102] := 'Cleanup';
      ExecCommand[103] := 'FinishTimeStep';
      ExecCommand[104] := 'NodeList';
+     ExecCommand[105] := 'Connect';
+     ExecCommand[106] := 'Disconnect';
 
 
 
@@ -460,6 +462,8 @@ implementation
                          'If the optional circuit element name is supplied, the program makes it the active element. Usage:' +CRLF+CRLF+
                          'NodeList' + CRLF +
                          'NodeList Line.Myline';
+     CommandHelp[105] := 'Request to create a TCP/IP socket to communicate data with external modules. This function requires the host address and TCP port to connect.';
+     CommandHelp[106] := 'Request to terminate a TCP/IP socket. This function requires the host address and TCP port to disconnect.';
 
 End;
 
@@ -686,6 +690,8 @@ implementation
       102: EndofTimeStepCleanup;
       103: FinishTimeStep;
       104: CmdResult := DoNodeListCmd;
+      105: CmdResult := DoConnectCmd; //'TCP/IP connect';
+      106: CmdResult := DoDisConnectCmd; //'TCP/IP disconnect';
      ELSE
        // Ignore excess parameters
      End;

Source/Executive/ExecOptions.pas

@@ -11,7 +11,7 @@ interface
 Uses Command;
 
 CONST
-        NumExecOptions = 110;
+        NumExecOptions = 111;
 
 VAR
          ExecOption,
@@ -143,6 +143,7 @@ implementation
      ExecOption[108] := 'StepTime';
      ExecOption[109] := 'SampleEnergyMeters';
      ExecOption[110] := 'MinIterations'; // default is 2
+     ExecOption[111] := 'DSSVisualizationTool';
 
 
 
@@ -396,6 +397,8 @@ implementation
                         'Normally Time and Duty modes do not automatically sample EnergyMeters whereas Daily, Yearly, M1, M2, M3, LD1 and LD2 modes do. ' +
                         'Use this Option to turn sampling on or off';
      OptionHelp[110] := 'Minimum number of iterations required for a solution. Default is 2.';
+     OptionHelp[111] := 'Activates/Deactivates the extended version of the plot command for figures with the DSS Visualization Tool.';
+
 End;
 //----------------------------------------------------------------------------
 FUNCTION DoSetCmd_NoCircuit:Boolean;  // Set Commands that do not require a circuit
@@ -427,6 +430,9 @@ implementation
            67: DSSExecutive.RecorderOn := InterpretYesNo(Param);
            73: DefaultBaseFreq  := Parser.DblValue;
           102: UpdateRegistry   := InterpretYesNo(Param);
+          111:  begin
+            DSS_Viz_enable  :=  InterpretYesNo(Param);
+          end;
          ELSE
             Begin
                 DoSimpleMsg('You must create a new circuit object first: "new circuit.mycktname" to execute this Set command.', 301);
@@ -619,6 +625,8 @@ implementation
           107: ActiveCircuit.Solution.Total_Time  :=  Parser.DblValue;
           109: ActiveCircuit.Solution.SampleTheMeters :=  InterpretYesNo(Param);
           110: ActiveCircuit.solution.MinIterations   := Parser.IntValue;
+          111: DSS_Viz_enable  :=  InterpretYesNo(Param);
+
          ELSE
            // Ignore excess parameters
          End;
@@ -795,6 +803,8 @@ implementation
           108: AppendGlobalResult(Format('%-g' ,[ActiveCircuit.Solution.Time_Step]));
           109: If ActiveCircuit.Solution.SampleTheMeters Then AppendGlobalResult('Yes') else AppendGlobalResult('No');
           110: AppendGlobalResult(IntToStr(ActiveCircuit.solution.MinIterations));
+          111: if DSS_Viz_enable then AppendGlobalResult('Yes') else AppendGlobalResult('No');
+
          ELSE
            // Ignore excess parameters
          End;

Source/Executive/PlotOptions.pas

@@ -204,11 +204,14 @@ implementation
                      ValueIndex := 2;
                     End;
                'C': PlotType := ptCircuitplot;
+               'E': PlotType := ptEvolutionPlot;
                'G': PlotType := ptGeneralDataPlot;
                'L': PlotType := ptLoadshape;
-               'M': PlotType := ptMonitorplot;
+               'M': IF CompareTextShortest('mon', Param)=0 Then PlotType := ptMonitorplot
+                    ELSE PlotType := ptMatrixplot;
                'P': IF CompareTextShortest('pro', Param)=0 Then PlotType := ptProfile
                     ELSE PlotType := ptPriceShape;
+               'S': PlotType := ptScatterPlot;
                'T': PlotType := ptTshape;
                'D': Begin
                       PlotType := ptDaisyplot;
@@ -293,9 +296,26 @@ implementation
      If Not ActiveCircuit.Issolved Then DSSPlotObj.Quantity := pqNone;
 
      With DSSPlotObj Do Begin
-
-        Execute;   // makes a new plot based on these options
-
+        if DSS_Viz_enable then
+        begin
+          if (DSS_Viz_installed and ((
+              PlotType = ptMonitorplot) or (
+              PlotType = ptLoadshape) or (
+              PlotType = ptProfile) or (
+              PlotType = ptScatterPlot) or (
+              PlotType = ptEvolutionPlot) or (
+              PlotType = ptMatrixplot))) then
+            DSSVizPlot; // DSS Visualization tool
+        end
+        else
+        begin
+          if (PlotType = ptScatterPlot) or (
+             PlotType = ptEvolutionPlot) or (
+             PlotType = ptMatrixplot) then
+             DoSimpleMsg('The DSS Visualization tool is disabled (Check the DSSVisualizationTool option).',0)
+          else
+             Execute;   // makes a new plot based on these options
+        end;
      End;
 
 End;

Source/Plot/DSSPlot.pas

@@ -33,7 +33,8 @@ interface
 Type
    TPlotType = (ptAutoAddLogPlot, ptCircuitplot, ptGeneralDataPlot,
       ptGeneralCircuitPlot, ptmonitorplot, ptdaisyplot, ptMeterZones,
-      ptLoadShape, ptTShape, ptPriceShape, ptProfile);
+      ptLoadShape, ptTShape, ptPriceShape, ptProfile, ptScatterPlot,
+      ptEvolutionPlot, ptMatrixplot);
    TPlotQuantity = (pqVoltage, pqCurrent, pqPower, pqLosses, pqCapacity,
       pqNone);
 
@@ -122,6 +123,7 @@    TDSSPlot = class(TObject)
 
       Procedure Execute;
       Procedure SetDefaults;
+      procedure DSSVizPlot;
 
       Procedure DoLoadShapePlot(Const LoadShapeName: String);
       Procedure DoTempShapePlot(Const TempShapeName: String);
@@ -170,6 +172,7 @@    TGenPlotItemList = class(TList)
 implementation
 
 Uses DSSGraph,
+   TCP_IP,
    Comobj,
    DSSClassDefs,
    DssGlobals,
@@ -1089,6 +1092,31 @@ procedure TDSSPlot.Execute;
 
 end;
 
+procedure TDSSPlot.DSSVizPlot;
+begin
+  If Not Assigned(DSSConnectObj) Then // First connection
+  begin
+    DSSConnectObj := TDSSConnect.Create;  // Creates the connection
+  end;
+
+  DSSConnectObj.Connect;  // Connects to the server
+
+  Case PlotType of  // Classifies the plot message
+    ptmonitorplot:
+      DSSConnectObj.MonitorPlotMsg(ObjectName);
+    ptLoadshape:
+      DSSConnectObj.LoadshapePlotMsg(ObjectName);
+    ptProfile:
+      DSSConnectObj.ProfilePlotMsg(ObjectName);
+    ptScatterPlot:
+      DSSConnectObj.ScatterPlotMsg;
+    ptEvolutionPlot:
+      DSSConnectObj.EvolutionPlotMsg;
+    ptMatrixplot:
+      DSSConnectObj.MatrixPlotMsg;
+  End;
+end;
+
 function TDSSPlot.InterpolateGradientColor(Color1, Color2: TColor;
    Ratio: Double): TColor;
 const