DSS C-API Pascal Docs

Class TEnergyMeter

Description
Hierarchy
Fields
Methods
Properties

Unit

EnergyMeter

Declaration

type TEnergyMeter = class(TMeterClass)

Description

No description available, ancestor TMeterClass description follows
No description available, ancestor TCktElementClass description follows
No description available, ancestor TDSSClass description follows

Base for all collection classes

Hierarchy

Overview

Fields

Protected Delta_Hrs: Double;
Protected BusAdjPC: TAdjArray;
Protected BusAdjPD: TAdjArray;
Public OV_MHandle: TBytesStream;
Public VR_MHandle: TBytesStream;
Public OV_Append: Boolean;
Public VR_Append: Boolean;
Public SDI_Append: Boolean;
Public TDI_Append: Boolean;
Public SM_Append: Boolean;
Public EMT_Append: Boolean;
Public FM_Append: Boolean;
Protected SDI_MHandle: TBytesStream;
Protected TDI_MHandle: TBytesStream;
Protected SM_MHandle: TBytesStream;
Protected EMT_MHandle: TBytesStream;
Protected FM_MHandle: TBytesStream;
Public DI_RegisterTotals: TRegisterArray;
Public DI_Dir: String;
Public FDI_Totals: TFileStream;
Public FMeterTotals: TFileStream;
Public SystemMeter: TSystemMeter;
Public Do_OverloadReport: Boolean;
Public Do_VoltageExceptionReport: Boolean;
Public OverLoadFileIsOpen: Boolean;
Public VoltageFileIsOpen: Boolean;

Methods

Protected procedure DefineProperties; override;
Protected procedure SetHasMeterFlag;
Public constructor Create(dssContext: TDSSContext);
Public destructor Destroy; OVERRIDE;
Public function BeginEdit(ptr: Pointer; SetActive_: Boolean=True): Pointer; override;
Public function EndEdit(ptr: Pointer; const NumChanges: integer): Boolean; override;
Public Function NewObject(const ObjName: String; Activate: Boolean = True): Pointer; OVERRIDE;
Public procedure ResetMeterZonesAll;
Public procedure ResetAll; OVERRIDE;
Public procedure SampleAll; OVERRIDE;
Public procedure SaveAll; OVERRIDE;
Public procedure AppendAllDIFiles;
Public procedure OpenAllDIFiles;
Public procedure CloseAllDIFiles;

Properties

Public property SaveDemandInterval: Boolean READ FSaveDemandInterval WRITE Set_SaveDemandInterval;
Public property DI_Verbose: Boolean READ FDI_Verbose WRITE Set_DI_Verbose;

Description

Fields

Protected Delta_Hrs: Double;

Moved from global unit vars

Protected BusAdjPC: TAdjArray;

adjacency lists for PC and PD elements at each bus, built for faster searches

Protected BusAdjPD: TAdjArray;

also includes shunt PD elements

Public OV_MHandle: TBytesStream;

******************************************************************************** * Nomenclature: * * OV_ Overloads * * VR_ Voltage report * * DI_ Demand interval * * SI_ System Demand interval * * TDI_ DI Totals * * FM_ Meter Totals * * SM_ System Mater * * EMT_ Energy Meter Totals * * PHV_ Phase Voltage Report * * These prefixes are applied to the variables of each file mapped into * * Memory using the MemoryMap_Lib * ********************************************************************************

Public VR_MHandle: TBytesStream;

a. Handle to the file in memory

Public OV_Append: Boolean;
 
Public VR_Append: Boolean;
 
Public SDI_Append: Boolean;
 
Public TDI_Append: Boolean;
 
Public SM_Append: Boolean;
 
Public EMT_Append: Boolean;
 
Public FM_Append: Boolean;
 
Protected SDI_MHandle: TBytesStream;
 
Protected TDI_MHandle: TBytesStream;
 
Protected SM_MHandle: TBytesStream;
 
Protected EMT_MHandle: TBytesStream;
 
Protected FM_MHandle: TBytesStream;
 
Public DI_RegisterTotals: TRegisterArray;
 
Public DI_Dir: String;
 
Public FDI_Totals: TFileStream;
 
Public FMeterTotals: TFileStream;
 
Public SystemMeter: TSystemMeter;
 
Public Do_OverloadReport: Boolean;
 
Public Do_VoltageExceptionReport: Boolean;
 
Public OverLoadFileIsOpen: Boolean;
 
Public VoltageFileIsOpen: Boolean;
 

Methods

Protected procedure DefineProperties; override;
 
Protected procedure SetHasMeterFlag;
 
Public constructor Create(dssContext: TDSSContext);
 
Public destructor Destroy; OVERRIDE;
 
Public function BeginEdit(ptr: Pointer; SetActive_: Boolean=True): Pointer; override;
 
Public function EndEdit(ptr: Pointer; const NumChanges: integer): Boolean; override;
 
Public Function NewObject(const ObjName: String; Activate: Boolean = True): Pointer; OVERRIDE;
 
Public procedure ResetMeterZonesAll;
 
Public procedure ResetAll; OVERRIDE;
 
Public procedure SampleAll; OVERRIDE;

Reset all meters in active circuit to zero

Public procedure SaveAll; OVERRIDE;

Force all meters in active circuit to sample

Public procedure AppendAllDIFiles;
 
Public procedure OpenAllDIFiles;
 
Public procedure CloseAllDIFiles;
 

Properties

Public property SaveDemandInterval: Boolean READ FSaveDemandInterval WRITE Set_SaveDemandInterval;
 
Public property DI_Verbose: Boolean READ FDI_Verbose WRITE Set_DI_Verbose;
 
Generated by PasDoc 0.16.0.