PerformanceAdviser

Public Class

The tool to report performance problems in a given document.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.PerformanceAdviser

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

Syntax

public class PerformanceAdviser : IDisposable

The PerformanceAdviser type exposes the following members.

Properties

Name

Description

Public Property
IsValidObject

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

Methods

Name

Description

Public Method

AddRule

Adds a performance adviser rule to the list of rules.

Public Method

DeleteRule

Deletes a performance adviser rule from the list of rules.

Public Method

Dispose

Releases all resources used by the PerformanceAdviser

Public Method

Equals

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

Public Method
ExecuteAllRules

Executes all rules in the list on a given document.

Public Method

ExecuteRules(Document, IList.PerformanceAdviserRuleId.)

Executes selected rules on a given document.

Public Method
ExecuteRules(Document, IList.Int32.)

Executes selected rules on a given document.

Public Method

GetAllRuleIds

Retrieves an enumeration of rule Ids.

Public Method

GetElementFilterFromRule(Int32, Document)

Retrieves a filter to restrict elements to be checked.

Public Method

GetElementFilterFromRule(PerformanceAdviserRuleId, Document)

Retrieves a filter to restrict elements to be checked.

Public Method

GetHashCode

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

Public Method

GetNumberOfRules

Retrieves number of performance adviser rules in the list.

Public Method
Static Member

GetPerformanceAdviser

Returns the only instance of PerformanceAdviser in the Application.

Public Method

GetRuleDescription(Int32)

Retrieves the description of the rule.

Public Method

GetRuleDescription(PerformanceAdviserRuleId)

Retrieves the description of the rule.

Public Method

GetRuleId

Retrieves an id of a rule for a given index in the list.

Public Method

GetRuleName(Int32)

Retrieves the name of the rule.

Public Method

GetRuleName(PerformanceAdviserRuleId)

Retrieves the name of the rule.

Public Method

GetType

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

Public Method

IsRuleEnabled(Int32)

Retrieves an enabled/disabled status for the given rule.

Public Method

IsRuleEnabled(PerformanceAdviserRuleId)

Retrieves an enabled/disabled status for the given rule.

Public Method

PostWarning

Reports a problem detected during execution of a rule.

Public Method

SetRuleEnabled(Int32, Boolean)

Retrieves an enabled/disabled status for the given rule.

Public Method

SetRuleEnabled(PerformanceAdviserRuleId, Boolean)

Retrieves an enabled/disabled status for the given rule.

Public Method

ToString

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

Public Method

WillRuleCheckElements(Int32)

Reports if rule needs to be executed on individual elements.

Public Method

WillRuleCheckElements(PerformanceAdviserRuleId)

Reports if rule needs to be executed on individual elements.

Remarks

Class is an application-wide singleton that performs a dual role: it is a repository of rules to run in order to detect potential performance problems as well as an access point to execute checks.

Example

//Get the name of each registered PerformanceRule and then execute all of them.
foreach (PerformanceAdviserRuleId id in PerformanceAdviser.GetPerformanceAdviser().GetAllRuleIds())
{
    string ruleName = PerformanceAdviser.GetPerformanceAdviser().GetRuleName(id);
}
PerformanceAdviser.GetPerformanceAdviser().ExecuteAllRules(document);