ElectricalSystem
Provides access to the Electrical System in Autodesk Revit MEP.
Inheritance Hierarchy
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.MEPSystem
Autodesk.Revit.DB.Electrical.ElectricalSystem
Namespace: Autodesk.Revit.DB.Electrical
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax
public class ElectricalSystem : MEPSystemThe ElectricalSystem type exposes the following members.
Properties
Name
Description
Public Property
ApparentCurrent
The ApparentCurrent value of the Electrical System.
Public Property
ApparentCurrentPhaseA
The ApparentCurrentPhaseA value of the Electrical System.
Public Property
ApparentCurrentPhaseB
The ApparentCurrentPhaseB value of the Electrical System.
Public Property
ApparentCurrentPhaseC
The ApparentCurrentPhaseC value of the Electrical System.
Public Property
ApparentLoad
The ApparentLoad value of the Electrical System.
Public Property
ApparentLoadPhaseA
The ApparentLoadPhaseA value of the Electrical System.
Public Property
ApparentLoadPhaseB
The ApparentLoadPhaseB value of the Electrical System.
Public Property
ApparentLoadPhaseC
The ApparentLoadPhaseC value of the Electrical System.
Public Property
AssemblyInstanceId
The id of the assembly instance to which the element belongs.
(Inherited from Element)
Public Property
BalancedLoad
Reports whether the BalancedLoad is on or off.
Public Property
BaseEquipment
The base panel or equipment of the system.
(Inherited from MEPSystem)
Public Property
BaseEquipmentConnector
The connector within base equipment which is used to connect with system.
(Inherited from MEPSystem)
Public Property
Code Example
BoundingBox
Retrieves a box that circumscribes all geometry of the element.
(Inherited from Element)
Public Property
Category
Retrieves a Category object that represents the category or sub category in which the element resides.
(Inherited from Element)
Public Property
CircuitConnectionType
The circuit connection type of the electrical system.
Public Property
CircuitNamingIndex
The Circuit Naming Index where the Electrical System is located in its panel. The Circuit Naming Index is used to retrieve the Circuit Naming Index of the Electrical System.
Public Property
CircuitNumber
The CircuitNumber of the Electrical System.
Public Property
CircuitPathMode
The circuit path mode of the electrical system.
Public Property
CircuitType
The circuit type of the Electrical System.
Public Property
ConnectorManager
Connector manager of the system.
(Inherited from MEPSystem)
Public Property
Code Example
CreatedPhaseId
Id of a Phase at which the Element was created.
(Inherited from Element)
Public Property
Code Example
DemolishedPhaseId
Id of a Phase at which the Element was demolished.
(Inherited from Element)
Public Property
Code Example
DesignOption
Returns the design option to which the element belongs.
(Inherited from Element)
Public Property
Document
Returns the Document in which the Element resides.
(Inherited from Element)
Public Property
Elements
Terminal elements in the system.
(Inherited from MEPSystem)
Public Property
Frame
The Frame value of the Electrical System.
Public Property
Code Example
Geometry
Retrieves the geometric representation of the element.
(Inherited from Element)
Public Property
GroundConductorsNumber
The GroundConductors Number of the Electrical System.
Public Property
GroupId
The id of the group to which an element belongs.
(Inherited from Element)
Public Property
HasCustomCircuitPath
Checks whether the electrical system circuit path has been customized. If not, the property CircuitPathMode cannot be set as Custom explicitly.
Public Property
HasDesignParts
Indicates if the system has one or more design parts.
(Inherited from MEPSystem)
Public Property
HasFabricationParts
Indicates if the system has one or more fabrication parts.
(Inherited from MEPSystem)
Public Property
HasPathOffset
Whether the circuit path has a valid offset.
Public Property
HasPlaceholders
Indicates if the system has one or more placeholders.
(Inherited from MEPSystem)
Public Property
HotConductorsNumber
The HotConductors Number of the Electrical System.
Public Property
Code Example
Id
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element)
Public Property
IsBasePanelFeedThroughLugsOccupied
Checks if the feed through lugs of the base panel is already occupied.
Public Property
IsEmpty
Indicates if the system is empty or not.
(Inherited from MEPSystem)
Public Property
IsModifiable
Identifies if the element is modifiable.
(Inherited from Element)
Public Property
IsMultipleNetwork
Indicates if the system is well connected or not. The flag will enable the “Divide System” button.
(Inherited from MEPSystem)
Public Property
IsTransient
Indicates whether an element is transient or permanent.
(Inherited from Element)
Public Property
IsValid
Indicates if the system is valid or not. atom AtomValidateSystem default false
(Inherited from MEPSystem)
Public Property
IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element)
Public Property
Length
The Length value of the Electrical System.
Public Property
LevelId
The id of the level associated with the element.
(Inherited from Element)
Public Property
LoadClassificationAbbreviations
The LoadClassification Abbreviations used in the Electrical System.
Public Property
LoadClassifications
The LoadClassifications used in the Electrical System.
Public Property
LoadName
The LoadName of the Electrical System.
Public Property
Code Example
Location
This property is used to find the physical location of an element within a project.
(Inherited from Element)
Public Property
Name
A human readable name for the Element.
(Inherited from Element)
Public Property
NeutralConductorsNumber
The NeutralConductors Number of the Electrical System.
Public Property
OwnerViewId
The id of the view that owns the element.
(Inherited from Element)
Public Property
PanelName
The Panel name of the Electrical System.
Public Property
Code Example
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
Parameter.Guid.
Retrieves a parameter from the element given a GUID for a shared parameter.
(Inherited from Element)
Public Property
Code Example
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
PathOffset
The offset of the horizontal segments of the circuit path.
Public Property
PhaseLabel
The circuit phase label used in the Electrical System.
Public Property
Pinned
Identifies if the element has been pinned to prevent changes.
(Inherited from Element)
Public Property
PolesNumber
The Poles Number of the Electrical System.
Public Property
PowerFactor
The PowerFactor value of the Electrical System.
Public Property
PowerFactorState
The PowerFactorState type of the Electrical System.
Public Property
PressureLossOfCriticalPath
The total pressure loss of the sections in critical path.
(Inherited from MEPSystem)
Public Property
Rating
The Rating value of the Electrical System.
Public Property
RunsNumber
The Runs Number of the Electrical System.
Public Property
SectionsCount
The number of sections.
(Inherited from MEPSystem)
Public Property
SlotIndex
The Slots where the Electrical System is located in its panel.
Public Property
StartSlot
The Start Slot where the Electrical System is located in its panel.
Public Property
SystemType
The Electrical System Type of the Electrical System.
Public Property
TrueCurrent
The TrueCurrent value of the Electrical System.
Public Property
TrueCurrentPhaseA
The TrueCurrentPhaseA value of the Electrical System.
Public Property
TrueCurrentPhaseB
The TrueCurrentPhaseB value of the Electrical System.
Public Property
TrueCurrentPhaseC
The TrueCurrentPhaseC value of the Electrical System.
Public Property
TrueLoad
The TrueLoad value of the Electrical System.
Public Property
TrueLoadPhaseA
The TrueLoadPhaseA value of the Electrical System.
Public Property
TrueLoadPhaseB
The TrueLoadPhaseB value of the Electrical System.
Public Property
TrueLoadPhaseC
The TrueLoadPhaseC value of the Electrical System.
Public Property
Code Example
UniqueId
A stable unique identifier for an element within the document.
(Inherited from Element)
Public Property
VersionGuid
Get the element version Guid.
(Inherited from Element)
Public Property
ViewSpecific
Identifies if the element is owned by a view.
(Inherited from Element)
Public Property
Voltage
The Voltage value of the Electrical System.
Public Property
VoltageDrop
The VoltageDrop value of the Electrical System.
Public Property
Ways
The circuit ways used in the Electrical System.
Public Property
WireSizeString
The WireSize as a String of the Electrical System
Public Property
WireType
The wire type of the Electrical System.
Public Property
WorksetId
Get Id of the Workset which owns the element.
(Inherited from Element)
Methods
Name
Description
Public Method
Add
Add elements into the system and connect them with the system using given connectors.
(Inherited from MEPSystem)
Public Method
AddToCircuit
Add a set of exist components to the Electrical System.
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
CanDeleteSubelement
Checks if given subelement can be removed from the element.
(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
Create(Connector, ElectricalSystemType)
Creates a new MEP Electrical System element from an unused Connector.
Public Method
Static Member
Create(Document, IList.ElementId., ElectricalSystemType)
Creates a new MEP Electrical System element from a set of electrical components.
Public Method
DeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element)
Public Method
DeleteSubelement
Removes a subelement from the element.
(Inherited from Element)
Public Method
DeleteSubelements
Removes the subelements from the element.
(Inherited from Element)
Public Method
DisconnectPanel
Disconnect the panel for the Electrical System.
Public Method
Dispose
(Inherited from Element)
Public Method
DivideSystem
Divide the phyisical networks in the system and create a new system for each network.
(Inherited from MEPSystem)
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object)
Public Method
EvaluateAllParameterValues
Evaluates all the parameters’ values of the element.
(Inherited from Element)
Public Method
EvaluateParameterValues
Evaluate the parameters’ values of the element on the given parameter ID set.
(Inherited from Element)
Public Method
GetCircuitPath
Gets the list of the electrical system circuit path node position.
Public Method
GetCriticalPathSectionNumbers
Obtains a list of the critical path section numbers.
(Inherited from MEPSystem)
Public Method
GetDependentElements
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element)
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
GetExternalResourceReferenceExpanded
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element)
Public Method
GetExternalResourceReferences
Gets the map of the external resource references referenced by the element.
(Inherited from Element)
Public Method
GetExternalResourceReferencesExpanded
Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element)
Public Method
Code Example
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 the default hash function.
(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
GetParameter
Retrieves a parameter from the element given identifier.
(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
GetPhysicalNetworksNumber
Get the physical networks number in the system.
(Inherited from MEPSystem)
Public Method
GetSectionByIndex
Get the section from the index.
(Inherited from MEPSystem)
Public Method
GetSectionByNumber
Get the Section from section number
(Inherited from MEPSystem)
Public Method
GetSubelements
Returns the collection of element subelements.
(Inherited from Element)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object)
Public Method
Code Example
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
IsCircuitPathValid
Checks whether the list of the electrical system circuit path node position is valid.
Public Method
IsCreatedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)
Public Method
IsDemolishedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element)
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
IsSystemDividable
Checks if the system is dividable. The system is dividable if there is more than one physical network in the system. Currently, only HVAC and piping systems support dividing.
(Inherited from MEPSystem)
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
NewWires
Create a bunch of wires for the electrical system.
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
Remove(ConnectorSet)
Removes connectors from system.
(Inherited from MEPSystem)
Public Method
Remove(ICollection.ElementId.)
Remove elements from system.
(Inherited from MEPSystem)
Public Method
RemoveFromCircuit
remove a set of exist components from the Electrical System.
Public Method
SelectPanel
Set the panel for the Electrical System.
Public Method
SetCircuitPath
Sets the electrical system circuit path by the list of node position.
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)
Remarks
The Electrical System object can only be queried in Autodesk Revit MEP.