Index: dam engine/trunk/src/Deltares.DamEngine.Interface/FillXmlOutputFromDam.cs
===================================================================
diff -u -r460 -r520
--- dam engine/trunk/src/Deltares.DamEngine.Interface/FillXmlOutputFromDam.cs (.../FillXmlOutputFromDam.cs) (revision 460)
+++ dam engine/trunk/src/Deltares.DamEngine.Interface/FillXmlOutputFromDam.cs (.../FillXmlOutputFromDam.cs) (revision 520)
@@ -1,8 +1,8 @@
// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
-// This file is part of the DAM Engine.
+// This file is part of the Dam Engine.
//
-// The DAM Engine is free software: you can redistribute it and/or modify
+// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
Index: dam engine/trunk/src/Deltares.DamEngine.Interface/EngineInterface.cs
===================================================================
diff -u -r501 -r520
--- dam engine/trunk/src/Deltares.DamEngine.Interface/EngineInterface.cs (.../EngineInterface.cs) (revision 501)
+++ dam engine/trunk/src/Deltares.DamEngine.Interface/EngineInterface.cs (.../EngineInterface.cs) (revision 520)
@@ -30,6 +30,9 @@
namespace Deltares.DamEngine.Interface
{
+ ///
+ /// The main interface class for accessing the Dam Engine
+ ///
public class EngineInterface
{
private ProgressDelegate progressDelegate;
@@ -39,7 +42,7 @@
///
/// Initializes a new instance of the class.
///
- /// The model input.
+ /// Xml string containing the model input.
public EngineInterface(string modelInput)
{
if (String.IsNullOrEmpty(modelInput))
@@ -150,9 +153,10 @@
///
/// Runs this instance.
///
- /// Errors and warnings in an XML string
- public string Run(out string outputXml)
+ /// Returns the output in an XML string
+ public string Run()
{
+ string outputXml;
SendMessage(new LogMessage() { MessageType = LogMessageType.Info, Message = "Start calculation" });
switch (DamProjectData.DamProjectType)
Index: dam engine/trunk/src/Deltares.DamEngine.Interface.Tests/EngineInterfaceTests.cs
===================================================================
diff -u -r501 -r520
--- dam engine/trunk/src/Deltares.DamEngine.Interface.Tests/EngineInterfaceTests.cs (.../EngineInterfaceTests.cs) (revision 501)
+++ dam engine/trunk/src/Deltares.DamEngine.Interface.Tests/EngineInterfaceTests.cs (.../EngineInterfaceTests.cs) (revision 520)
@@ -50,10 +50,9 @@
string inputString = File.ReadAllText(fileName);
EngineInterface engineInterface = new EngineInterface(inputString);
Assert.IsNotNull(engineInterface.DamProjectData);
- string outputString;
- var calculationMessages = engineInterface.Run(out outputString);
- Assert.IsNotNull(calculationMessages);
+ string outputString = engineInterface.Run();
Assert.IsNotNull(outputString);
+ Assert.IsNotNull(outputString);
}
}
Index: dam engine/trunk/src/Deltares.DamEngine.Data/Standard/Delegates.cs
===================================================================
diff -u -r452 -r520
--- dam engine/trunk/src/Deltares.DamEngine.Data/Standard/Delegates.cs (.../Delegates.cs) (revision 452)
+++ dam engine/trunk/src/Deltares.DamEngine.Data/Standard/Delegates.cs (.../Delegates.cs) (revision 520)
@@ -36,7 +36,7 @@
public delegate void SendMessageDelegate(LogMessage logMessage);
///
- /// Check if a user abort is requeste
+ /// Check if a user abort is requested
///
/// true if user requested an abort; else false
public delegate bool UserAbortDelegate();