altdss.EnergyMeterExtras

Module Contents

Classes

EnergyMeterBatchMixin
EnergyMeterObjMixin
IEnergyMeterMixin
MeterSection	Encapsulates meter section functions
MeterSections	Encapsulates meter sections to provide iteration and indexing.

API

class altdss.EnergyMeterExtras.EnergyMeterBatchMixin

DoReliabilityCalc(assumeRestoration: bool) → None

Calculate reliability indices for each meter

NumEndElements() → altdss.types.Int32Array

Number of zone end elements in the active meter zone.

NumSections() → altdss.types.Int32Array

Number of feeder sections in the zone of each meter

TotalCustomers() → altdss.types.Int32Array

Total Number of customers in this zone (downline from the EnergyMeter)

class altdss.EnergyMeterExtras.EnergyMeterObjMixin

property AllocFactors: altdss.types.Float64Array

Set the phase allocation factors for this meter.

Branches: altdss.PDElement.PDElementBatch

None

Accessor for all branches in the meter zone (internal SequenceList), in lexical order

property CalcCurrent: altdss.types.Float64Array

Set/get the magnitude of the real part of the Calculated Current (normally determined by solution) for the meter to force some behavior on Load Allocation

DoReliabilityCalc(assumeRestoration: bool) → None

Calculate reliability indices

EndElements: altdss.CircuitElement.CircuitElementBatch

None

Accessor for all branches in the meter zone.

Loads() → altdss.Load.LoadBatch

Accessor for all loads in the meter zone (internal LoadList).

NOTE: this a snapshot of the loads; if the circuit is updated, the batch is not updated automatically, i.e., you need to get a new batch from this function.

NumEndElements() → int

Number of zone end elements in the active meter zone.

NumSections() → int

Number of feeder sections in this meter’s zone

Section(idx: int) → altdss.EnergyMeterExtras.MeterSection

Returns a wrapper for a single meter section

Sections() → altdss.EnergyMeterExtras.MeterSections

Returns a wrapper for meter sections

Sequence: altdss.CircuitElement.CircuitElementBatch

None

TotalCustomers() → int

Total Number of customers in this zone (downline from the EnergyMeter)

ZonePCEs: altdss.PCElement.PCElementBatch

None

Accessor for all zone end elements for this meter.

__init__()

class altdss.EnergyMeterExtras.IEnergyMeterMixin

CloseDIFiles()

Close all Demand Interval files. Users are required to close the DI files at the end of a run, either using this function or the CloseDI DSS command.

DIFilesAreOpen() → bool

Indicates if Demand Interval (DI) files have been properly opened.

OpenDIFiles()

Open Demand Interval (DI) files

Totals() → altdss.types.Float64Array

Returns the totals of all registers of all meters

class altdss.EnergyMeterExtras.MeterSection(meter, idx)

Encapsulates meter section functions

AvgRepairTime() → float

FaultRateXRepairHours() → float

Index() → int

NumBranches() → int

NumCustomers() → int

OCPDeviceType() → dss.enums.OCPDevType

SequenceIndex() → int

SumBranchFaultRates() → float

TotalCustomers() → int

__init__(meter, idx)

as_dict()

class altdss.EnergyMeterExtras.MeterSections(meter)

Encapsulates meter sections to provide iteration and indexing.

__call__(idx: int) → altdss.EnergyMeterExtras.MeterSection

Returns a meter section by index

__getitem__

None

__init__(meter)

__iter__() → Iterator[altdss.EnergyMeterExtras.MeterSection]

__len__() → int