AnalysisResultSchema

Public Class

Contains all information about one analysis result. Each result may contain several measurements.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Analysis.AnalysisResultSchema

Namespace: Autodesk.Revit.DB.Analysis

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class AnalysisResultSchema : IDisposable

The AnalysisResultSchema type exposes the following members.

Constructors

Name

Description

---

Public Method
AnalysisResultSchema(AnalysisResultSchema)

Constructs a new copy of the input AnalysisResultSchema object.

---

Public Method
AnalysisResultSchema(String, String)

Creates object and assigns name and description

---

Properties

Name

Description

---

Public Property

AnalysisDisplayStyleId

ElementId of analysis display style overriding the style set for view; -1 if the style is not overridden

---

Public Property
CurrentUnits

Stores the index in the array of applicable units

---

Public Property

Description

Description of analysis result in view

---

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

---

Public Property

IsVisible

If true analysis result is visible in view

---

Public Property

Name

Name of analysis result in view

---

Public Property

Scale

Multiplier used for displaying diagram or vector values in view.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the AnalysisResultSchema

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetNumberOfUnits

returns number of possible units

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

GetUnitsMultiplier

returns units multiplier by index

---

Public Method

GetUnitsName

returns units name by index

---

Public Method

IsEqual

Determines if the input object is equivalent to this AnalysisResultSchema.

---

Public Method
Code Example

SetUnits

Sets names and multipliers of all units for result visualization

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

In order to take effect, the AnalysisResultSchema object has to be registered by calling SpatialFieldManager::RegisterResult, which returns result index for future references; to make changes to the properties of an already registered object, use method SpatialFieldManager::SetResultSchema and supply result index and replacing object.

Example

// By default, each analysis result uses the Analysis Display Style assigned to the view.
// To display different types of results (colored surface, markers, diagram, vector) simultaneously in a single view
// the Analysis Display Style for each result must be set to a style that matches result's type
foreach (int result in spatialFieldManager.GetRegisteredResults()) // get all results for this SpatialFieldManager
{
   AnalysisResultSchema schema = spatialFieldManager.GetResultSchema(result);
   switch (schema.Name)  // check the name of the schema
   {
      case "Reactions": // based on the schema name, set the schema's Analysis Display Style
         schema.AnalysisDisplayStyleId = AnalysisDisplayStyle.FindByName(doc, "Vector");
         break;
      case "Shear":
         schema.AnalysisDisplayStyleId = AnalysisDisplayStyle.FindByName(doc, "Diagram");
         break;
      case "Plate Shear":
         schema.AnalysisDisplayStyleId = AnalysisDisplayStyle.FindByName(doc, "Surface");
         break;
   }
   spatialFieldManager.SetResultSchema(result, schema); // update the schema
}