assets/samples/Samples/GeometryAPI/EnergyAnalysisModel/CS/README_extracted.txt

AUTHOR: duans

Application: EnergyAnalysisModel
Revit Platform: All
Revit Version: 2012.0
First Released For: 2012.0
Programming Language: C#
Skill Level: Medium
Category: Analysis
Type: ExternalCommand

Subject: EnergyAnalysisModel
Summary: This sample is to demonstrate how to create use EnergyAnalysisModel. This project will get energy analytical model according to the defined options and show faces structure by a tree view.

Classes: 
Autodesk.Revit.UI.IExternalCommand
Autodesk.Revit.Document
Autodesk.Revit.Element
Autodesk.Revit.DB;
Autodesk.Revit.DB.Analysis;

Project Files: 
Command.cs
This file contains a class Command which implements IExternalCommand interface. The function of the class is to create an instance of EnergyAnalysisModel and pop the dialog for inputs and display.

EnergyAnalysisModel.cs
This file contains a class EnergyAnalysisModel which accepts options inputs, gets analytical data from current building model, and also display surface information by a tree view.
        

OptionsAndAnalysisForm.cs
This file contains a window form which allows user to do UI input and view analytical data.

Description: 
The sample implements IExternalCommand interface and allows user to define the options of energy analysis and view the analytical data.
-       
To get analytical openings information, use the method GetAnalyticalOpenings of EnergyAnalysisModel.
-       
To get analytical shading surfaces information, use the method GetAnalyticalShadingSurfaces of EnergyAnalysisModel.
-       
To get analytical spaces information, use the method GetAnalyticalSpaces of EnergyAnalysisModel.
-       
To view new analytical model, use the method RefreshAnalysisData of EnergyAnalysisModel.

Instructions: 
1.      
Set up addin file and start Revit to load this sample.
2.      
Launch EnergyAnalysis Model via the external command menu.
4.      
Input the Options including Tier value, ExportMullions, IncludeShadingSurfaces and SimplifyCurtainSystems. Click Refresh button.
6.      
According to the options you set, the sample will display energy analytical data of current building model. You can view its surface information by clicking the tree view.
7.      
Click Close button to end.