EnergyDataSettings Members


The EnergyDataSettings type exposes the following members.

Methods

Name Description
Public method ArePhasesModifiable
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element .)
Public method CanBeHidden
Indicates if the element can be hidden in the view.
(Inherited from Element .)
Public method CanBeLocked
Identifies if the element can be locked.
(Inherited from Element .)
Public method CanHaveAnalyticalModel
Indicates whether the Element can have an Analytical Model.
(Inherited from Element .)
Public method CanHaveTypeAssigned
Identifies if the element can have a type assigned.
(Inherited from Element .)
Public method ChangeTypeId(ElementId)
Changes the type of the element.
(Inherited from Element .)
Public method Static member CheckAnalysisType
Checks that the analysis type falls within an appropriate range.
Public method Static member CheckBuildingConstructionClass
Checks that the building construction class falls within an appropriate range.
Public method Static member CheckBuildingEnvelope
Checks that the building envelope determination method falls within an appropriate range.
Public method Static member CheckBuildingHVACSystem
Checks that the building HVAC system falls within an appropriate range.
Public method Static member CheckBuildingOperatingSchedule
Checks that the building operating schedule falls within an appropriate range.
Public method Static member CheckBuildingType
Checks that the building type falls within an appropriate range.
Public method CheckConstructionSetElement
Checks that the construction set ElementId is acceptable.
Public method Static member CheckExportCategory
Checks whether the export category falls within the list:
  1. OST_Rooms
  2. OST_MEPSpaces
Public method Static member CheckExportComplexity
Checks that the export complexity falls within an appropriate range.
Public method CheckGroundPlane(ElementId)
The ground plane should be an Element of type Level. This method checks to confirm that an ElementId is for a Level element.
Public method Static member CheckGroundPlane(Document, ElementId)
The ground plane should be an Element of type Level. This method checks to confirm that an ElementId is for a Level element.
Public method CheckProjectPhase
Checks that the input element is a project phase.
Public method Static member CheckProjectReportType
Checks that the project report type falls within an appropriate range.
Public method Static member CheckRangeOfMassZoneCoreOffset Obsolete.
Checks that the mass zone core offset is greater than or equal to zero.
Public method Static member CheckRangeOfPercentageGlazing
Checks that the percentage glazing value is between 0.00 and 0.95.
Public method Static member CheckRangeOfPercentageSkylights
Checks that the percentage skylights value is between 0.00 and 0.95.
Public method Static member CheckRangeOfShadeDepth
Checks that the shade depth is greater than or equal to zero.
Public method Static member CheckRangeOfSillHeight
Checks that the sill height is greater than or equal to zero.
Public method Static member CheckRangeOfSkylightWidth
Checks that the skylight width is greater than or equal to eight inches.
Public method Static member CheckRangeOfSliverSpaceTolerance
Checks that the sliver space tolerance is greater than or equal to zero.
Public method Static member CheckServiceType
Checks that the service type falls within an appropriate range.
Public method DeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element .)
Public method Dispose (Inherited from Element .)
Public method Static member EnableConceptualEnergyAnalyticalModel
Turns on functionality related to conceptual energy analysis.
Public method Equals
Determines whether the specified Object is equal to the current Object .
(Inherited from Object .)
Public method GetAnalyticalModel
Retrieves writeable Analytical Model for Element.
(Inherited from Element .)
Public method GetAnalyticalModelId
Retrieves the Element Id of the Analytical Model Element for this Element.
(Inherited from Element .)
Public method Static member GetBuildingConstructionSetElementId
Id of the building construction set.
Public method GetEntity
Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element .)
Public method GetEntitySchemaGuids
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element .)
Public method GetExternalFileReference
Gets information pertaining to the external file referenced by the element.
(Inherited from Element .)
Public method GetExternalResourceReference
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element .)
Public method GetExternalResourceReferences
Gets the full map of the external resource references referenced by the element.
(Inherited from Element .)
Public method Static member GetFromDocument
Every project document has a EnergyDataSettings element. Family documents do not have EnergyDataSettings elements.
Public method GetGeneratingElementIds
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element .)
Public method GetGeometryObjectFromReference
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element .)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object .)
Public method GetMaterialArea
Gets the area of the material with the given id.
(Inherited from Element .)
Public method GetMaterialIds
Gets the element ids of all materials present in the element.
(Inherited from Element .)
Public method GetMaterialVolume
Gets the volume of the material with the given id.
(Inherited from Element .)
Public method GetMonitoredLinkElementIds
Provides the link instance IDs when the element is monitoring.
(Inherited from Element .)
Public method GetMonitoredLocalElementIds
Provides the local element IDs when the element is monitoring.
(Inherited from Element .)
Public method GetOrderedParameters
Gets the parameters associated to the element in order.
(Inherited from Element .)
Public method GetParameterFormatOptions
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element .)
Public method GetParameters
Retrieves the parameters from the element via the given name.
(Inherited from Element .)
Public method GetPhaseStatus
Gets the status of a given element in the input phase
(Inherited from Element .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method GetTypeId
Returns the identifier of this element's type.
(Inherited from Element .)
Public method GetValidTypes
Obtains a set of types that are valid for this element.
(Inherited from Element .)
Public method HasPhases
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element .)
Public method Static member IsDocumentUsingEnergyDataAnalyticalModel
Get EnergyDataSettings element and if it exists, return result from getCreateAnalyticalModel.
Public method IsExternalFileReference
Determines whether this Element represents an external file.
(Inherited from Element .)
Public method IsHidden
Identifies if the element has been permanently hidden in the view.
(Inherited from Element .)
Public method IsMonitoringLinkElement
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element .)
Public method IsMonitoringLocalElement
Indicate whether an element is monitoring other local elements.
(Inherited from Element .)
Public method IsPhaseCreatedValid
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element .)
Public method IsPhaseDemolishedValid
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element .)
Public method IsValidType(ElementId)
Checks if given type is valid for this element.
(Inherited from Element .)
Public method LookupParameter
Attempts to find a parameter on the element which has the given name.
(Inherited from Element .)
Public method RefersToExternalResourceReference
Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element .)
Public method RefersToExternalResourceReferences
Determines whether this Element uses external resources.
(Inherited from Element .)
Public method SetCreateAnalyticalModel
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.
Public method SetEntity
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)

Properties

Name Description
Public property AnalysisType
The type of analysis mode.
Public property AnalyticalGridCellSize
The cell size for the uniform cubical grid used when computing the building envelope
Public property AssemblyInstanceId
The id of the assembly instance to which the element belongs.
(Inherited from Element .)
Public property BoundingBox
Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element .)
Public property BuildingConstructionClass
Used for both the detailed and conceptual energy model Construction class of building as defined by: loose, medium, tight, or none.
Public property BuildingEnvelopeDeterminationMethod
Indicates if an analysis should be perform to find the model elements that are part of the building envelope
Public property BuildingHVACSystem
The type of HVAC system used by the building for conceptual model energy calculations.
Public property BuildingOperatingSchedule
The operating schedule of the building used for conceptual model energy calculations.
Public property BuildingType
The type of building.
Public property Category
Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element .)
Public property CoreOffset
The default offset used to determine the outer perimeter to be divided into zones.
Public property CreateAnalyticalModel
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.
Public property CreatedPhaseId
Id of a Phase at which the Element was created.
(Inherited from Element .)
Public property DemolishedPhaseId
Id of a Phase at which the Element was demolished.
(Inherited from Element .)
Public property DesignOption
Returns the design option to which the element belongs.
(Inherited from Element .)
Public property DividePerimeter
If this is true, zones with exterior boundaries on each floor of the building will be divided based on geometric criteria.
Public property Document
Returns the Document in which the Element resides.
(Inherited from Element .)
Public property EnergyModel
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.
Public property ExportCategory
Value is a category indicating which discipline model will be used for GreenBuildingXML export.
Public property ExportComplexity
Value determines Export Complexity for GreenBuildingXML detailed model export.
Public property ExportDefaults
Use for detailed model GreenBuildingXML export. When this setting is true, all building and space defaults, schedules, and constructions will be exported to GreenBuildingXML. When this setting is false, only values that are specified on the zone or space will be exported to GreenBuildingXML.
Public property Geometry
Retrieves the geometric representation of the element.
(Inherited from Element .)
Public property GroundPlane
Id of level which represents ground level.
Public property GroupId
The id of the group to which an element belongs.
(Inherited from Element .)
Public property Id
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element .)
Public property IncludeThermalProperties
Indicates if thermal information from model assemblies and components is included in GreenBuildingXML export of the detailed model.
Public property IsExportMullionsEnabled
Indicates if mullions are included in GreenBuildingXML export of the detailed model.
Public property IsExportShadingSurfacesEnabled
Indicates if "shading surfaces" are included in GreenBuildingXML export of the detailed model.
Public property IsExportSimplifiedCurtainSystemsEnabled
Indicates if curtain system geometry is being simplified for GreenBuildingXML export of the detailed model.
Public property IsGlazingShaded
If this is true, glazing/windows that are auto-created on exterior walls will automatically have a shading device created on their top edge.
Public property IsTransient
Indicates whether an element is transient or permanent.
(Inherited from Element .)
Public property IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element .)
Public property LevelId
The id of the level associated with the element.
(Inherited from Element .)
Public property Location
This property is used to find the physical location of an element within a project.
(Inherited from Element .)
Public property MassZoneCoreOffset Obsolete.
It defines the default behavior for the automatic generation of Mass Zones for each Mass Floor in the Project. Specifying a value here will offset the outside perimeter of a Mass Zone to create the core.
Public property MassZoneDividePerimeter Obsolete.
If this is true, outward facing zones on each floor of the building will be divided based on the four compass directions.
Public property Name
A human readable name for the Element.
(Inherited from Element .)
Public property OutsideAirChangesRatePerHour
The number of times the volume of air interchanges in the room in one hour.
Public property OutsideAirPerArea
The rate of flow of outside air available per unit area.
Public property OutsideAirPerPerson
The rate of flow of outside air available per person.
Public property OwnerViewId
The id of the view that owns the element.
(Inherited from Element .)
Public property Parameter Guid
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element .)
Public property Parameter BuiltInParameter
Retrieves a parameter from the element given a parameter id.
(Inherited from Element .)
Public property Parameter Definition
Retrieves a parameter from the element based on its definition.
(Inherited from Element .)
Public property Parameters
Retrieves a set containing all of the parameters that are contained within the element.
(Inherited from Element .)
Public property ParametersMap
Retrieves a map containing all of the parameters that are contained within the element.
(Inherited from Element .)
Public property PercentageGlazing
Used for the conceptual energy model. The approximate percentage of the building exterior wall surfaces which are covered by windows or other glazing.
Public property PercentageSkylights
Used for the conceptual energy model. The approximate percentage of the building roof surfaces in massing instances for the Conceptual Energy Analytical Model.
Public property Pinned
Identifies if the element has been pinned to prevent changes.
(Inherited from Element .)
Public property ProjectPhase
The project phase of the EnergyData information.
Public property ProjectReportType
Report type: None, simple, standard, detailed
Public property ServiceType
The type of heating or cooling system.
Public property ShadeDepth
Used for the conceptual energy model. Amount that auto-generated shading will extend from auto-generated windows.
Public property SillHeight
Used for the conceptual energy model. The height from the nearest lower level used for auto-glazing created on walls.
Public property SkylightWidth
Used for the conceptual energy model. The approximate width used for the skylights in massing instances when the Energy Analytical model is being created.
Public property SliverSpaceTolerance
Used for Detailed GreenBuildingXML export. This value is used to identify sliver spaces, i.e. spaces bounded by parallel surfaces belonging to different rooms.
Public property UniqueId
A stable unique identifier for an element within the document.
(Inherited from Element .)
Public property UseAirChangesPerHour
True if user is specifying air changes per hour, false otherwise.
Public property UseHeatingCredits
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.
Public property UseOutsideAirPerArea
True is user is specifying outside air per area, false otherwise.
Public property UseOutsideAirPerPerson
True if user is specifying outside air per person, false otherwise.
Public property ViewSpecific
Identifies if the element is owned by a view.
(Inherited from Element .)
Public property WorksetId
Get Id of the Workset which owns the element.
(Inherited from Element .)

See Also