2020 Class
Changes 8
C

ElectricalSystem

Description:
Provides access to the Electrical System in Autodesk Revit MEP.
Remarks:
The Electrical System object can only be queried in Autodesk Revit MEP.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.MEPSystem
      Autodesk.Revit.DB.Electrical.ElectricalSystem
public class ElectricalSystem : MEPSystem
Name Return Type Description Inherited From
M AddToCircuit(ElementSet) nullNothingnullptr Add a set of exist components to the Electrical System.
M Create(Connector, ElectricalSystemType) nullNothingnullptr Creates a new MEP Electrical System element from an unused Connector.
M Create(Document, IList<ElementId>, ElectricalSystemType) nullNothingnullptr Creates a new MEP Electrical System element from a set of electrical components.
M DisconnectPanel() None Disconnect the panel for the Electrical System.
M GetCircuitPath() IList<XYZ> Gets the list of the electrical system circuit path node position.
M IsCircuitPathValid(IList<XYZ>) bool Checks whether the list of the electrical system circuit path node position is valid.
M NewWires(View, WiringType) New created wires Create a bunch of wires for the electrical system.
M RemoveFromCircuit(ElementSet) None remove a set of exist components from the Electrical System.
M SelectPanel(FamilyInstance) None Set the panel for the Electrical System.
M SetCircuitPath(IList<XYZ>) None Sets the electrical system circuit path by the list of node position.
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
M Add(ConnectorSet) None Add elements into the system and connect them with the system using given connectors. MEPSystem
M DivideSystem(Document) ICollection<ElementId> Divide the phyisical networks in the system and create a new system for each network. MEPSystem
M GetCriticalPathSectionNumbers() The section numbers. Obtains a list of the critical path section numbers. MEPSystem
M GetPhysicalNetworksNumber() int Get the physical networks number in the system. MEPSystem
M GetSectionByIndex(Int32) The section. Get the section from the index. MEPSystem
M GetSectionByNumber(Int32) nullNothingnullptr Get the Section from section number MEPSystem
M IsSystemDividable() bool 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. MEPSystem
M Remove(ConnectorSet) None Removes connectors from system. MEPSystem
M Remove(ICollection<ElementId>) None Remove elements from system. MEPSystem
Name Return Type Description Inherited From
P ApparentCurrentPhaseA double The ApparentCurrentPhaseA value of the Electrical System.
P ApparentCurrentPhaseB double The ApparentCurrentPhaseB value of the Electrical System.
P ApparentCurrentPhaseC double The ApparentCurrentPhaseC value of the Electrical System.
P ApparentCurrent double The ApparentCurrent value of the Electrical System.
P ApparentLoadPhaseA double The ApparentLoadPhaseA value of the Electrical System.
P ApparentLoadPhaseB double The ApparentLoadPhaseB value of the Electrical System.
P ApparentLoadPhaseC double The ApparentLoadPhaseC value of the Electrical System.
P ApparentLoad double The ApparentLoad value of the Electrical System.
P BalancedLoad bool Reports whether the BalancedLoad is on or off.
P CircuitConnectionType CircuitConnectionType The circuit connection type of the electrical system.
P CircuitNumber string The CircuitNumber of the Electrical System.
P CircuitPathMode ElectricalCircuitPathMode The circuit path mode of the electrical system.
P CircuitType CircuitType The circuit type of the Electrical System.
P GroundConductorsNumber int The GroundConductors Number of the Electrical System.
P HasCustomCircuitPath bool Checks whether the electrical system circuit path has been customized. If not, the property CircuitPathMode cannot be set as Custom explicitly.
P HasPathOffset bool Whether the circuit path has a valid offset.
P HotConductorsNumber int The HotConductors Number of the Electrical System.
P IsBasePanelFeedThroughLugsOccupied bool Checks if the feed through lugs of the base panel is already occupied.
P Length double The Length value of the Electrical System.
P LoadClassifications string The LoadClassifications used in the Electrical System.
P LoadName string The LoadName of the Electrical System.
P NeutralConductorsNumber int The NeutralConductors Number of the Electrical System.
P PanelName string The Panel name of the Electrical System.
P PathOffset double The offset of the horizontal segments of the circuit path.
P PolesNumber int The Poles Number of the Electrical System.
P PowerFactor double The PowerFactor value of the Electrical System.
P PowerFactorState PowerFactorStateType The PowerFactorState type of the Electrical System.
P Rating double The Rating value of the Electrical System.
P RunsNumber int The Runs Number of the Electrical System.
P StartSlot int The Start Slot where the Electrical System is located in its panel.
P SystemType ElectricalSystemType The Electrical System Type of the Electrical System.
P TrueCurrentPhaseA double The TrueCurrentPhaseA value of the Electrical System.
P TrueCurrentPhaseB double The TrueCurrentPhaseB value of the Electrical System.
P TrueCurrentPhaseC double The TrueCurrentPhaseC value of the Electrical System.
P TrueCurrent double The TrueCurrent value of the Electrical System.
P TrueLoadPhaseA double The TrueLoadPhaseA value of the Electrical System.
P TrueLoadPhaseB double The TrueLoadPhaseB value of the Electrical System.
P TrueLoadPhaseC double The TrueLoadPhaseC value of the Electrical System.
P TrueLoad double The TrueLoad value of the Electrical System.
P VoltageDrop double The VoltageDrop value of the Electrical System.
P Voltage double The Voltage value of the Electrical System.
P WireSizeString string The WireSize as a String of the Electrical System
P WireType WireType The wire type of the Electrical System.
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
P BaseEquipmentConnector nullNothingnullptr The connector within base equipment which is used to connect with system. MEPSystem
P BaseEquipment FamilyInstance The base panel or equipment of the system. MEPSystem
P ConnectorManager ConnectorManager Connector manager of the system. MEPSystem
P Elements ElementSet Terminal elements in the system. MEPSystem
P HasDesignParts bool Indicates if the system has one or more design parts. MEPSystem
P HasFabricationParts bool Indicates if the system has one or more fabrication parts. MEPSystem
P HasPlaceholders bool Indicates if the system has one or more placeholders. MEPSystem
P IsEmpty bool Indicates if the system is empty or not. MEPSystem
P IsMultipleNetwork bool Indicates if the system is well connected or not. The flag will enable the "Divide System" button. MEPSystem
P IsValid bool Indicates if the system is valid or not. atom AtomValidateSystem default false MEPSystem
P PressureLossOfCriticalPath double The total pressure loss of the sections in critical path. MEPSystem
P SectionsCount int The number of sections. MEPSystem