ViewSystemsAnalysisReportRequestSystemsAnalysis Method

Requests a new systems analysis in the background.

Namespace: Autodesk.Revit.DB.Analysis
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
Copy
public void RequestSystemsAnalysis(
	SystemsAnalysisOptions options
)

Parameters

options  SystemsAnalysisOptions
The additional options to run systems analysis. If empty, use the default value in the view element. The request may download the weather file at current site location if not specified in the options.
Exceptions
ExceptionCondition
ArgumentNullException A non-optional argument was null
ArgumentsInconsistentException No weather station is within 500 nautical miles of this site location.
FileNotFoundException Fail to download the weather file.
InvalidOperationException A valid energy model is required for systems analysis. -or- Unable to access the weather service. Try again later.
Example
Copy
// Create a new report and request systems analysis on the current energy model.
ViewSystemsAnalysisReport newReport = null;

SystemsAnalysisOptions theOptions = new SystemsAnalysisOptions();
string openStudioPath = Path.GetFullPath(Path.Combine(doc.Application.SystemsAnalysisWorkfilesRootPath, @"..\"));
// The following are the default values for systems analysis if not specified.
// If the weather file is not specified, the analysis will use the weather at the current site location.
theOptions.WorkflowFile = Path.Combine(openStudioPath, @"workflows\HVAC Systems Loads and Sizing.osw");
theOptions.OutputFolder = Path.GetTempPath();
using (Transaction transaction = new Transaction(doc))
{
   transaction.Start("Create Systems Analysis View");

   newReport = ViewSystemsAnalysisReport.Create(doc, "APITestView");
   // Create a new report of systems analysis. 
   if (newReport != null)
   {
      newReport.RequestSystemsAnalysis(theOptions);
      // Request the systems analysis in the background process. When the systems analysis is completed, 
      // the result is automatically updated in the report view and the analytical space elements.
      // You may check the status by calling newReport.IsAnalysisCompleted().
      transaction.Commit();
   }
   else
   {
      transaction.RollBack();
   }
}
See Also