Skip to content
RevitAPI doc lite

Autodesk.Revit.DB.Analysis

Classes

Class

Description

Public Class
Code Example
AnalysisDisplayColoredSurfaceSettings

Contains colored surface settings for analysis display style element.

Public Class
AnalysisDisplayColorEntry

Contains one entry of intermediate colors in color settings for analysis display style.

Public Class
Code Example
AnalysisDisplayColorSettings

Contains color settings for analysis display style element.

Public Class
AnalysisDisplayDeformedShapeSettings

Contains deformed shape settings for analysis display style element.

Public Class
AnalysisDisplayDiagramSettings

Contains diagram settings for analysis display style element.

Public Class
AnalysisDisplayLegend

The legend that describes an Analysis Visualization.

Public Class
Code Example
AnalysisDisplayLegendSettings

Contains legend settings for analysis display style element.

Public Class
Code Example
AnalysisDisplayMarkersAndTextSettings

Contains markers and text settings for analysis display style element.

Public Class
Code Example
AnalysisDisplayStyle

Exposes API for manipulation of analysis display style.

Public Class
AnalysisDisplayVectorSettings

Contains vector settings for analysis display style element.

Public Class
Code Example
AnalysisResultSchema

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

Public Class
BuildingEnvelopeAnalyzer

Analyzes which elements are part of the building envelope, the building elements exposed to the outside.

Public Class
BuildingEnvelopeAnalyzerOptions

Specific options for the method analyzing the building elements for the building envelope.

Public Class
BuildingOperatingDaySchedule

Represents the operating schedule of a 24 hour day.

Public Class
BuildingOperatingYearSchedule

Represents an operating schedule that contains 365 daily usage BuildingOperatingDaySchedules.

Public Class
ConceptualConstructionType

This element is used to describe the conceptual physical, construction, and energy properties in a manner that can be understood by both the Revit BIM model and Green Building Studio/Green Building XML. For serialization

Public Class
ConceptualSurfaceType

This element represents a conceptual BIM object category to assign to faces in Mass geometries. There is one ConceptualSurfaceType element for each of the Mass Surface Subcategories. for serialization

Public Class
CriticalPathCollector

This class is used to search and traverse the network analytical segments on the critical path.

Public Class
CriticalPathIterator

An iterator to traverse the critical path in the CriticalPathCollector.

Public Class
EnergyAnalysisConstruction

Represent an analytical construction as a composite of layered materials.

Public Class
Code Example
EnergyAnalysisDetailModel

Manage the analytical thermal model.

Public Class
EnergyAnalysisDetailModelOptions

Options that govern the calculations for the generation of the energy analysis detail model.

Public Class
EnergyAnalysisMaterial

A description of a material with thermal properties in a composite construction.

Public Class
EnergyAnalysisOpening

Analytical opening.

Public Class
EnergyAnalysisSpace

Analytical space.

Public Class
EnergyAnalysisSurface

Analytical surface. The collection of analytic openings belonging to this analytical parent surface

Public Class
EnergyAnalysisWindowType

The EnergyAnalysisWindowType class contains the thermal properties (e.g., heat transfer coefficient) of the window-type analytical openings.

Public Class
EnergyAnalysisZone

Analytical zone.

Public Class
Code Example
EnergyDataSettings

This element contains settings for gbXML Export and Heating and Cooling Load Calculations and project level settings for Conceptual Energy Analysis. for serialization

Public Class
FieldDomainPoints

Abstract base class for various classes of field domain points

Public Class
Code Example
FieldDomainPointsByParameter

Represents a set of one-dimensional point coordinates (defined usually on curve)

Public Class
FieldDomainPointsByUV

Represents a set of two-dimensional point coordinates (defined usually on surface)

Public Class
FieldDomainPointsByXYZ

Represents a set of three-dimensional point coordinates

Public Class
FieldValues

Contains values corresponding to domain points. Each domain point may have an array of values, each corresponding to a separate “measurement” for which this value was calculated.

Public Class
GenericZone

Provides access to the GenericZone Element in Autodesk Revit.

Public Class
GenericZoneDomainData

A base class for specific domain requirements for a generic zone.

Public Class
HVACLoadBuildingType

The type element of building.

Public Class
HVACLoadSpaceType

The type element of space.

Public Class
HVACLoadType

The base class for building type and space type.

Public Class
MassLevelData

MassLevelData is a conceptual representation of an occupiable floor (Mass Floor) in a conceptual building model. It is defined by associating a particular level with a particular mass element in a Revit project.

Public Class
MassSurfaceData

Obsolete.
Holds properties and other data about a face in the MassEnergyAnalyticalModel element.

Public Class
MEPAnalyticalModelData

Represents the MEP analytical model data attached to individual element.

Public Class
MEPAnalyticalNode

Represents an analytical node of the MEP analytical model.

Public Class
MEPAnalyticalSegment

Represents an analytical segment of the MEP analytical model.

Public Class
Code Example
MEPNetworkIterator

An iterator to traverse the MEP analytical network.

Public Class
MEPNetworkSegmentData

Represents the analysis data for one network segment.

Public Class
MEPNetworkSegmentId

Represents a unique identifier for one analytical segment in the network.

Public Class
PathOfTravel

An element which holds a graphical representation of the shortest route between two points in the plane of a floor plan view. The shortest route is calculated to go around model geometry visible in the view. Route calculation is affected by properties of the RouteAnalysisSettings element.

Public Class
PathOfTravelCalculationServerIds

Ids for external servers implementing path of travel calculations.

Public Class
Polyloop

A Polyloop represent a planar polygon with ordered points.

Public Class
RouteAnalysisSettings

RouteAnalysisSettings is an element which contains project-wide settings for route calculations. The PathOfTravel element uses these settings to calculate a route between two points in a plan view.

By default, the route will go around the geometry of all visible model elements which have model geometry in the Route Analysis Zone.

The Route Analysis Zone, determined per view, is the space between these two horizontal planes: a top plane vertically offset by AnalysisZoneTopOffset above the view’s level and a bottom plane vertically offset by AnalysisZoneBottomOffset ft above the view’s level.

By default, the route will ignore the following elements:

  • elements outside of the crop region of the view;
  • elements without any model geometry (annotations or view-specific elements);
  • model lines (category OST_Lines);
  • demolished elements;
  • elements displayed in the underlay of the view.

There are a few ways to customize Route Analysis on a project-wide basis.

You can adjust the Route Analysis Zone using AnalysisZoneTopOffset and AnalysisZoneBottomOffset.

You can specify a set of model categories you would like ignored during route calculation. To enable ignoring the set of specified categories, set

EnableIgnoredCategoryIds

to true. To change the set of ignored categories, use SetIgnoredCategoryIds method and

IgnoreImports

and IgnorePointClouds properties. To query the set of ignored categories, use

GetIgnoredCategoryIds

.

Public Class
Code Example
SpatialFieldManager

Exposes all API for an external analysis application. Its primary role is creation, deletion and modification of SpatialFieldElement elements.

Public Class
SystemsAnalysisOptions

Contains the options for systems analysis.

Public Class
ValueAtPoint

Stores values at one domain point. Each value corresponds to a “measurement” for which this value was calculated.

Public Class
Code Example
VectorAtPoint

Stores vectors at one domain point. Each vector corresponds to a “measurement” for which this vector was calculated.

Public Class
ViewSystemsAnalysisReport

Represents a report instance of the systems analysis.

Enumerations

Enumeration

Description

Public Enum
AllowLargeGeometry

An enumerated type containing settings information related to handling of large geometries.

Public Enum
AnalysisDisplayStyleColorSettingsType

Defines types for color settings of analysis display style.

Public Enum
AnalysisDisplayStyleDeformedShapeTextLabelType

Defines text visualization types for deformed shape settings of analysis display style.

Public Enum
AnalysisDisplayStyleDiagramFenceType

Defines fence visualization types for diagram settings of analysis display style.

Public Enum
AnalysisDisplayStyleDiagramTextLabelType

Defines text label visualization types for diagram settings of analysis display style.

Public Enum
AnalysisDisplayStyleMarkerTextLabelType

Text label visualization types for Markers and Text settings of analysis display style.

Public Enum
AnalysisDisplayStyleMarkerType

Marker types for Markers and Text settings of analysis display style.

Public Enum
AnalysisDisplayStyleVectorArrowheadScale

Defines arrow head scaling for vector settings of analysis display style.

Public Enum
AnalysisDisplayStyleVectorOrientation

Defines vector orientation for vector settings of analysis display style.

Public Enum
AnalysisDisplayStyleVectorPosition

Defines vector position for vector settings of analysis display style.

Public Enum
AnalysisDisplayStyleVectorTextType

Defines text visualization types for vector settings of analysis display style.

Public Enum
AnalysisMode

This enum is used to define the Energy Analysis Model.

Public Enum
ConceptualConstructionFloorSlabType

ConceptualConstructionType values for Floors.

Public Enum
ConceptualConstructionOpeningType

ConceptualConstructionType values for Openings.

Public Enum
ConceptualConstructionRoofType

ConceptualConstructionType values for Roofs.

Public Enum
ConceptualConstructionShadeType

ConceptualConstructionType values for Shades.

Public Enum
ConceptualConstructionWallType

ConceptualConstructionType values for Walls.

Public Enum
ConceptualConstructionWindowSkylightType

ConceptualConstructionType values for Windows and Skylights

Public Enum
ConstructionType

This enumeration specifies the available analytical construction types like external walls, windows etc. for use in the detailed analytical energy model.

Public Enum
EnergyAnalysisDetailModelTier

Level of computation for energy analysis model.

Public Enum
EnergyAnalysisOpeningType

Energy analysis opening type.

Public Enum
EnergyAnalysisSurfaceType

Analytical surface types.

Public Enum
EnergyModelType

This enum is used to define if the energy model is based on rooms/spaces, building elements or analysis mode in EnergyDataSettings.

Public Enum
gbXMLBuildingHVACSystem

Enumerations for gbXML (Green Building XML) format, used for energy analysis, schema version 0.34.

Public Enum
gbXMLBuildingOperatingSchedule

Enumerations for gbXML (Green Building XML) format, used for energy analysis, schema version 0.34.

Public Enum
gbXMLBuildingType

Enumerations for gbXML (Green Building XML) format, used for energy analysis, schema version 0.34.

Public Enum
gbXMLConditionType

This enumeration corresponds to the conditionType attribute in gbXML. The enumerated attribute identifies the type of heating, cooling, or ventilation the space has.

Public Enum
gbXMLExportBuildingEnvelope

Indicates the determination method for the building envelope

Public Enum
gbXMLExportComplexity

This enumeration specifies the level of detail of the exported analytical energy model in gbXML. Complex means that Curtain Walls and Curtain Systems are exported as several openings, panel by panel; a curtain wall with 50 panels gets exported as 50 openings. Simple means that one “huge” opening with the total opening area equal to the 50 panels is exported. This is more appropriate for most energy analysis. Mullions mean that Mullions in Curtain Walls and Systems are exported as shading surfaces. A “simplified” analytical shading surface is produced from a mullion based on its centerline, thickness and offset.

Public Enum
gbXMLOpeningType

This enumeration corresponds to the openingType attribute in gbXML and identifies the type of opening defined.

Public Enum
gbXMLServiceType

This enumeration corresponds to the systemType attribute in gbXML and is used for specifying the service for the building or space.

Public Enum
gbXMLSpaceType

This enumeration corresponds to the spaceType attribute in gbXML. The enumerated attribute identifies the type of space defined and allows to better approximate the actual internal loads and schedules associated with the defined space type.

Public Enum
gbXMLSurfaceType

This enumeration corresponds to the surfaceType attribute in gbXML and identifies the type of surface defined.

Public Enum
HVACLoadConstructionClass

Enumerated type listing options for construction class for HVAC analysis.

Public Enum
HVACLoadLoadsReportType

Enumerated type listing possible types of reports generated for HVAC loads.

Public Enum
MassSurfaceDataMaterialType

Indicates how the visualization material for the MassSurfaceData is calculated.

Public Enum
MassSurfaceDataSource

Indicates whether values for the properties of the MassSurfaceData are synchronized with the EnergyDataSettings of the document or instead, serve as overrides of those settings.

Public Enum
MEPAnalyticalSegmentType

The type of analytical segment.

Public Enum
OutdoorAirFlowStandard

An enumerated type listing all the possible outdoor airflow standard for a space type.

Public Enum
PathOfTravelCalculationStatus

An enumerated type containing possible results of the Path of Travel calculation.

Public Enum
SpatialFieldPrimitiveHideMode

Defines modes which can be used by a SpatialFieldPrimitive to hide the original referenced element.

Public Enum
SystemsAnalysisReportStyle

The report style of systems analysis.