Results
A few conventions are in place to display nice results in the ArupCompute Web UI. You are not forced to follow them, ArupCompute will do its best to display your result anyway!
If your method returns a simple type (double, int, string...) that will be displayed in the result box, but no quick report or other fancy feature will be available. To support them, your method will have to return an ArupComputeResult object and implement the fields mentioned below.
The ArupComputeResult Class
To facilitate consistency in results we have written the ArupComputeResult class provided as part of the ArupCompute .NET SDK.
Whilst returning an ArupComputeResult from your functions is not mandatory it is required to enable certain features (reports, correct functioning of Grasshopper & Excel clients etc.)
This class has predefined fields you can use to return your outputs, to use it add the using Arup.Compute.DotNetSdk; directive to your classes.
ArupComputeResultItems
This field on the class is used to return consistent results so that they can be used in the various clients in a similar way. It also allows to output multiple results.
A sample implementation is the one below:
using Arup.Compute.DotNetSdk;
// c# boilerplate
[Calculation("Multiple Result", "Example of how to write a calculation that returns multiple results. This function takes in some text and returns one result containg the numbers found in the text and in another the other carachters. ", "[email protected]", Arup.Compute.DotNetSdk.Enums.LevelOfReview.Complete)]
public static ArupComputeResult SplitNumbersAndText(string text)
{
var numbers = "";
var others = "";
foreach (var l in text)
{
if (Char.IsNumber(l))
{
numbers += l;
}
else
{
others += l;
}
}
ArupComputeResultItem r1 = new ArupComputeResultItem();
r1.Description = "Numbers found in the input text";
r1.Value = numbers;
ArupComputeResultItem r2 = new ArupComputeResultItem();
r2.Description = "Other characters found in the input text";
r2.Value = others;
ArupComputeResult result = new ArupComputeResult();
result.ArupComputeResultItems = new List<ArupComputeResultItem>();
result.ArupComputeResultItems.Add(r1);
result.ArupComputeResultItems.Add(r2);
return result;
}
HTML
The ArupComputeResult.ArupComputeReport_HTML field is used to enable report output on the website, it can contain almost any HTML tag, so you can easily embed tables and SVG graphics.
For example:
[Calculation("Sample SVG", "This function shows how to add custom HTML to your function output. It can contain most HTML tags, as for instance SVG, make sure to click he Quick Report button below!", "[email protected]", Arup.Compute.DotNetSdk.Enums.LevelOfReview.Complete)]
public static ArupComputeResult SVG(string text)
{
var result = new ArupComputeResult();
result.ArupComputeReport_HTML = text + @"<br /><br /><svg xmlns=""http://www.w3.org/2000/svg"" width=""24"" height=""24"" viewBox=""0 0 24 24""><path d=""M12 0c-6.627 0-12 5.373-12 12s5.373 12 12 12 12-5.373 12-12-5.373-12-12-12zm0 2c3.691 0 6.915 2.016 8.647 5h-17.294c1.732-2.984 4.956-5 8.647-5zm0 20c-5.514 0-10-4.486-10-10 0-1.045.163-2.052.461-3h1.859c.606 1.518 1.929 3 3.986 3 2.477 0 2.153-2.31 3.694-2.31s1.218 2.31 3.695 2.31c2.055 0 3.379-1.482 3.984-3h1.86c.298.948.461 1.955.461 3 0 5.514-4.486 10-10 10zm5.508-8.059l.492.493c-1.127 1.72-3.199 3.566-5.999 3.566-2.801 0-4.874-1.846-6.001-3.566l.492-.493c1.513 1.195 3.174 1.931 5.509 1.931 2.333 0 3.994-.736 5.507-1.931z""/></svg>";
return result;
}
Pretty formulas
To display pretty formulas inside your quick report, you need to write them using the KaTeX notation and wrap each line in dollars $$.
For instance, the following code:
[Calculation("Pretty formula", "This is how to add pretty formuas to your report, make sure to click the Quick Report button below!",
"[email protected]", Arup.Compute.DotNetSdk.Enums.LevelOfReview.Complete)]
public static ArupComputeResult PrettyFormula()
{
var result = new ArupComputeResult();
result.ArupComputeReport_HTML = @"$$c = \pm\sqrt{a^2 + b^2}$$";
return result;
}
Will render as:
Errors, warnings and remarks
Errors, warnings and remarks, should be stored respectively inside the Errors, Warnings, Remarks fields as List<string>.
By convention:
Errorsa complete failure of the code and likely could not reach the point where results can be returnedWarningscode has been able to return a result, however the user should be very careful about using itRemarksomething has happened that the user should likely review - but if they take into account what has been said in the remark they can use the result
[Calculation("Errors Warnings & Remarks", "Shows how to use Errors, Warnings and Remarks. If the input number is < 0 will output an error, if < 5 a warning, if > 10 a remark.","[email protected]", Arup.Compute.DotNetSdk.Enums.LevelOfReview.Complete)]
public static ArupComputeResult ErrorsWaringsRemarks(double n)
{
var result = new ArupComputeResult();
result.ArupComputeReport_HTML = "<h1>Report:</h1></br>";
if (n < 0)
{
result.Errors = new List<string>();
result.Errors.Add("n is too low!");
result.Errors.Add("You forgot to buy milk today!");
result.ArupComputeReport_HTML += "<h3>Errors:</h3>";
result.ArupComputeReport_HTML += string.Join(" </br> ", result.Errors);
}
else if (n < 5)
{
result.Warnings = new List<string>();
result.Warnings.Add("n is quite low, but I'll let it pass for today...");
result.ArupComputeReport_HTML += "<h3>Warnings:</h3>";
result.ArupComputeReport_HTML += string.Join(" </br> ", result.Warnings);
}
else if (n > 10)
{
result.Remarks = new List<string>();
result.Remarks.Add("Good job, you picked a gread n value!");
result.Remarks.Add("Remember to buy milk today!");
result.ArupComputeReport_HTML += "<h3>Remarks:</h3>";
result.ArupComputeReport_HTML += string.Join(" </br> ", result.Remarks);
}
return result;
}