Sign in
2020 Class
Changes 7
C

EnergyDataSettings

Description:
This element contains settings for gbXML Export and Heating and Cooling Load Calculations and project level settings for Conceptual Energy Analysis. for serialization
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.Analysis.EnergyDataSettings
public class EnergyDataSettings : Element
public void GetInfo_EnergyData(Document document)
{
   EnergyDataSettings energyData = EnergyDataSettings.GetFromDocument(document);

   if (null != energyData)
    {
        string message = "energyData : ";
        message += "\nBuildingType : " + energyData.BuildingType;
        TaskDialog.Show("Revit",message);
    }
}
Name Return Type Description Inherited From
M CheckAnalysisType(AnalysisMode) bool Checks that the analysis type falls within an appropriate range.
M CheckBuildingConstructionClass(HVACLoadConstructionClass) bool Checks that the building construction class falls within an appropriate range.
M CheckBuildingEnvelope(gbXMLExportBuildingEnvelope) bool Checks that the building envelope determination method falls within an appropriate range.
M CheckBuildingHVACSystem(gbXMLBuildingHVACSystem) bool Checks that the building HVAC system falls within an appropriate range.
M CheckBuildingOperatingSchedule(gbXMLBuildingOperatingSchedule) bool Checks that the building operating schedule falls within an appropriate range.
M CheckBuildingType(gbXMLBuildingType) bool Checks that the building type falls within an appropriate range.
M CheckConstructionSetElement(ElementId) bool Checks that the construction set ElementId is acceptable.
M CheckExportCategory(ElementId) bool Checks whether the export category falls within the list: OST_RoomsOST_MEPSpaces
M CheckExportComplexity(gbXMLExportComplexity) bool Checks that the export complexity falls within an appropriate range.
M CheckGroundPlane(Document, ElementId) bool The ground plane should be an Element of type Level. This method checks to confirm that an ElementId is for a Level element.
M CheckGroundPlane(ElementId) bool The ground plane should be an Element of type Level. This method checks to confirm that an ElementId is for a Level element.
M CheckProjectPhase(ElementId) bool Checks that the input element is a project phase.
M CheckProjectReportType(HVACLoadLoadsReportType) bool Checks that the project report type falls within an appropriate range.
M CheckRangeOfPercentageGlazing(Double) bool Checks that the percentage glazing value is between 0.00 and 0.95.
M CheckRangeOfPercentageSkylights(Double) bool Checks that the percentage skylights value is between 0.00 and 0.95.
M CheckRangeOfShadeDepth(Double) bool Checks that the shade depth is greater than or equal to zero.
M CheckRangeOfSillHeight(Double) bool Checks that the sill height is greater than or equal to zero.
M CheckRangeOfSkylightWidth(Double) bool Checks that the skylight width is greater than or equal to eight inches.
M CheckRangeOfSliverSpaceTolerance(Double) bool Checks that the sliver space tolerance is greater than or equal to zero.
M CheckServiceType(gbXMLServiceType) bool Checks that the service type falls within an appropriate range.
M EnableConceptualEnergyAnalyticalModel() bool Turns on functionality related to conceptual energy analysis.
M GetBuildingConstructionSetElementId(Document) ElementId Id of the building construction set.
M GetFromDocument(Document) EnergyDataSettings Every project document has a EnergyDataSettings element. Family documents do not have EnergyDataSettings elements.
M IsDocumentUsingEnergyDataAnalyticalModel(Document) bool Get EnergyDataSettings element and if it exists, return result from getCreateAnalyticalModel.
M SetCreateAnalyticalModel(Boolean) None If this is true, data, features, and geometry related to the Energy Analytical Model will be created, allowing the energy performance to be analyzed through GreenBuilidingXML.
M ArePhasesModifiable() bool Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. Element
M CanBeHidden(View) bool Indicates if the element can be hidden in the view. Element
M CanBeLocked() bool Identifies if the element can be locked. Element
M CanDeleteSubelement(Subelement) bool Checks if given subelement can be removed from the element. Element
M CanHaveAnalyticalModel() bool Indicates whether the Element can have an Analytical Model. Element
M CanHaveTypeAssigned() bool Identifies if the element can have a type assigned. Element
M CanHaveTypeAssigned(Document, ICollection<ElementId>) bool Checks if all elements in the set can have a type assigned. Element
M ChangeTypeId(Document, ICollection<ElementId>, ElementId) IDictionary Changes the type of all elements in the given set. Element
M ChangeTypeId(ElementId) ElementId Changes the type of the element. Element
M DeleteEntity(Schema) bool Deletes the existing entity created by %schema% in the element Element
M DeleteSubelement(Subelement) bool Removes a subelement from the element. Element
M DeleteSubelements(IList<Subelement>) bool Removes the subelements from the element. Element
M Dispose() None Releases all resources used by the Element
M GetAnalyticalModelId() Element Id. Retrieves the Element Id of the Analytical Model Element for this Element. Element
M GetAnalyticalModel() Writeable Analytical Model. Retrieves writeable Analytical Model for Element. Element
M GetChangeTypeAny() ChangeType Returns ChangeType associated with any change in an element. Element
M GetChangeTypeElementAddition() ChangeType Returns ChangeType associated with element addition Element
M GetChangeTypeElementDeletion() ChangeType Returns ChangeType associated with element deletion. Element
M GetChangeTypeGeometry() ChangeType Returns ChangeType associated with a change in the geometry of an element Element
M GetChangeTypeParameter(ElementId) ChangeType Returns ChangeType associated with a change in a parameter's value Element
M GetChangeTypeParameter(Parameter) ChangeType Returns ChangeType associated with a change in a parameter's value Element
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. Element
M GetEntity(Schema) The returned Entity. Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. Element
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. Element
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. Element
M GetExternalResourceReferences() IDictionary Gets the full map of the external resource references referenced by the element. Element
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. Element
M GetMaterialArea(ElementId, Boolean) double Gets the area of the material with the given id. Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. Element
M GetMaterialVolume(ElementId) double Gets the volume of the material with the given id. Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. Element
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. Element
M GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. Element
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase Element
M GetSubelements() IList<Subelement> Returns the collection of element subelements. Element
M GetTypeId() ElementId Returns the identifier of this element's type. Element
M GetValidTypes() ICollection<ElementId> Obtains a set of types that are valid for this element. Element
M GetValidTypes(Document, ICollection<ElementId>) ICollection<ElementId> Obtains a set of types that are valid for all given elements. Element
M HasPhases() bool Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. Element
M IsExternalFileReference() bool Determines whether this Element represents an external file. Element
M IsHidden(View) bool Identifies if the element has been permanently hidden in the view. Element
M IsMonitoringLinkElement() bool Indicate whether an element is monitoring any elements in any linked models. Element
M IsMonitoringLocalElement() bool Indicate whether an element is monitoring other local elements. Element
M IsPhaseCreatedValid(ElementId) bool Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. Element
M IsPhaseDemolishedValid(ElementId) bool Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. Element
M IsValidType(Document, ICollection<ElementId>, ElementId) bool Checks if given type is valid for the set of elements. Element
M IsValidType(ElementId) bool Checks if given type is valid for this element. Element
M LookupParameter(String) nullNothingnullptr Attempts to find a parameter on the element which has the given name. Element
M RefersToExternalResourceReference(ExternalResourceType) bool Determines whether this Element uses external resources associated with a specified external resource type. Element
M RefersToExternalResourceReferences() bool Determines whether this Element uses external resources. Element
M SetEntity(Entity) None Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. Element
Name Return Type Description Inherited From
P AnalysisType AnalysisMode The type of analysis mode.
P AnalyticalGridCellSize double The cell size for the uniform cubical grid used when computing the building envelope
P BuildingConstructionClass HVACLoadConstructionClass Used for both the detailed and conceptual energy model Construction class of building as defined by: loose, medium, tight, or none.
P BuildingEnvelopeDeterminationMethod gbXMLExportBuildingEnvelope Indicates if an analysis should be perform to find the model elements that are part of the building envelope
P BuildingHVACSystem gbXMLBuildingHVACSystem The type of HVAC system used by the building for conceptual model energy calculations.
P BuildingOperatingSchedule gbXMLBuildingOperatingSchedule The operating schedule of the building used for conceptual model energy calculations.
P BuildingTypeId ElementId The building type element.
P BuildingType gbXMLBuildingType The type of building.
P CoreOffset double The default offset used to determine the outer perimeter to be divided into zones.
P CreateAnalyticalModel bool If this is true, data, features, and geometry related to the Energy Analytical Model will be created, allowing the energy performance to be analyzed through GreenBuilidingXML.
P DividePerimeter bool If this is true, zones with exterior boundaries on each floor of the building will be divided based on geometric criteria.
P EnergyModel bool if this is on there should be an energy model dependent on the current AnalysisType if it is off the conceptual energy model should be turned off but setting this datum does not do the work, just reflects the state.
P ExportCategory ElementId Value is a category indicating which discipline model will be used for GreenBuildingXML export.
P ExportComplexity gbXMLExportComplexity Value determines Export Complexity for GreenBuildingXML detailed model export.
P ExportDefaults bool Use for detailed model GreenBuildingXML export. When this setting is true, all building and space defaults, schedules, and constructions will be exported to GreenBuildingXML.
P GroundPlane ElementId Id of level which represents ground level.
P IncludeThermalProperties bool Indicates if thermal information from model assemblies and components is included in GreenBuildingXML export of the detailed model.
P IsExportMullionsEnabled bool Indicates if mullions are included in GreenBuildingXML export of the detailed model.
P IsExportShadingSurfacesEnabled bool Indicates if "shading surfaces" are included in GreenBuildingXML export of the detailed model.
P IsExportSimplifiedCurtainSystemsEnabled bool Indicates if curtain system geometry is being simplified for GreenBuildingXML export of the detailed model.
P IsGlazingShaded bool If this is true, glazing/windows that are auto-created on exterior walls will automatically have a shading device created on their top edge.
P OutsideAirChangesRatePerHour double The number of times the volume of air interchanges in the room in one hour.
P OutsideAirPerArea double The rate of flow of outside air available per unit area.
P OutsideAirPerPerson double The rate of flow of outside air available per person.
P PercentageGlazing double Used for the conceptual energy model. The approximate percentage of the building exterior wall surfaces which are covered by windows or other glazing.
P PercentageSkylights double Used for the conceptual energy model. The approximate percentage of the building roof surfaces in massing instances for the Conceptual Energy Analytical Model.
P ProjectPhase ElementId The project phase of the EnergyData information.
P ProjectReportType HVACLoadLoadsReportType Report type: None, simple, standard, detailed
P ServiceType gbXMLServiceType The type of heating or cooling system.
P ShadeDepth double Used for the conceptual energy model. Amount that auto-generated shading will extend from auto-generated windows.
P SillHeight double Used for the conceptual energy model. The height from the nearest lower level used for auto-glazing created on walls.
P SkylightWidth double Used for the conceptual energy model. The approximate width used for the skylights in massing instances when the Energy Analytical model is being created.
P SliverSpaceTolerance double Used for Detailed GreenBuildingXML export. This value is used to identify sliver spaces, i.e. spaces bounded by parallel surfaces belonging to different rooms.
P UseAirChangesPerHour bool True if user is specifying air changes per hour, false otherwise.
P UseHeatingCredits bool If true, Revit will use heating credits in the final load sum calculations. If false, Revit will ignore heating credits in the final load sum calculations.
P UseOutsideAirPerArea bool True is user is specifying outside air per area, false otherwise.
P UseOutsideAirPerPerson bool True if user is specifying outside air per person, false otherwise.
P AssemblyInstanceId ElementId The id of the assembly instance to which the element belongs. Element
P BoundingBox BoundingBoxXYZ Retrieves a box that circumscribes all geometry of the element. Element
P Category Category Retrieves a Category object that represents the category or sub category in which the element resides. Element
P CreatedPhaseId ElementId Id of a Phase at which the Element was created. Element
P DemolishedPhaseId ElementId Id of a Phase at which the Element was demolished. Element
P DesignOption DesignOption Returns the design option to which the element belongs. Element
P Document Document Returns the Document in which the Element resides. Element
P Geometry GeometryElement Retrieves the geometric representation of the element. Element
P GroupId ElementId The id of the group to which an element belongs. Element
P Id ElementId A unique identifier for an Element in an Autodesk Revit project. Element
P IsTransient bool Indicates whether an element is transient or permanent. Element
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. Element
P LevelId ElementId The id of the level associated with the element. Element
P Location Location This property is used to find the physical location of an element within a project. Element
P Name string A human readable name for the Element. Element
P OwnerViewId ElementId The id of the view that owns the element. Element
P Parameter Parameter Retrieves a parameter from the element given a parameter id. Element
P Parameter Parameter Retrieves a parameter from the element based on its definition. Element
P Parameter Parameter Retrieves a parameter from the element given a GUID for a shared parameter. Element
P ParametersMap ParameterMap Retrieves a map containing all of the parameters that are contained within the element. Element
P Parameters ParameterSet Retrieves a set containing all of the parameters that are contained within the element. Element
P Pinned bool Identifies if the element has been pinned to prevent changes. Element
P UniqueId string A stable unique identifier for an element within the document. Element
P ViewSpecific bool Identifies if the element is owned by a view. Element
P WorksetId WorksetId Get Id of the Workset which owns the element. Element