DSS C-API Pascal Docs

Class TDSSCircuit

Description
Hierarchy
Fields
Methods
Properties

Unit

Circuit

Declaration

type TDSSCircuit = class(TNamedObject)

Description

No description available, ancestor TNamedObject description follows

this is a GUID compliant to RFC 4122, v4

Hierarchy

Overview

Fields

Public DSS: TDSSContext;
Public ActiveBusIndex: Integer;
Public Fundamental: Double;
Public Control_BusNameRedefined: Boolean;
Public BusList: TBusHashListType;
Public AutoAddBusList: TBusHashListType;
Public DeviceList: THashList;
Public Faults: TDSSPointerList;
Public PDElements: TDSSPointerList;
Public PCElements: TDSSPointerList;
Public DSSControls: TDSSPointerList;
Public Sources: TDSSPointerList;
Public MeterElements: TDSSPointerList;
Public Sensors: TDSSPointerList;
Public Monitors: TDSSPointerList;
Public EnergyMeters: TDSSPointerList;
Public Generators: TDSSPointerList;
Public StorageElements: TDSSPointerList;
Public PVSystems: TDSSPointerList;
Public Substations: TDSSPointerList;
Public Transformers: TDSSPointerList;
Public AutoTransformers: TDSSPointerList;
Public CapControls: TDSSPointerList;
Public RegControls: TDSSPointerList;
Public Lines: TDSSPointerList;
Public Loads: TDSSPointerList;
Public ShuntCapacitors: TDSSPointerList;
Public Reactors: TDSSPointerList;
Public Relays: TDSSPointerList;
Public Fuses: TDSSPointerList;
Public Reclosers: TDSSPointerList;
Public InvControls: TDSSPointerList;
Public ExpControls: TDSSPointerList;
Public SwtControls: TDSSPointerList;
Public CktElements: TDSSPointerList;
Public IncrCktElements: TDSSPointerList;
Public LockIc: TCriticalSection;
Public ControlQueue: TControlQueue;
Public Solution: TSolutionObj;
Public AutoAddObj: TAutoAdd;
Public UEWeight: Double;
Public LossWeight: Double;
Public NumUEregs: Integer;
Public NumLossRegs: Integer;
Public Ueregs: pIntegerArray;
Public LossRegs: pIntegerArray;
Public CapacityStart: Double;
Public CapacityIncrement: Double;
Public TrapezoidalIntegration: Boolean;
Public LogEvents: Boolean;
Public LoadDurCurve: String;
Public LoadDurCurveObj: TLoadShapeObj;
Public PriceCurve: String;
Public PriceCurveObj: TPriceShapeObj;
Public NumDevices: Integer;
Public NumBuses: Integer;
Public NumNodes: Integer;
Public MaxDevices: Integer;
Public MaxBuses: Integer;
Public MaxNodes: Integer;
Public IncDevices: Integer;
Public IncBuses: Integer;
Public IncNodes: Integer;
Public Buses: pTBusArray;
Public MapNodeToBus: pTNodeBusArray;
Public Issolved: Boolean;
Public DuplicatesAllowed: Boolean;
Public ZonesLocked: Boolean;
Public MeterZonesComputed: Boolean;
Public PositiveSequence: Boolean;
Public NeglectLoadY: Boolean;
Public NormalMinVolts: Double;
Public NormalMaxVolts: Double;
Public EmergMaxVolts: Double;
Public EmergMinVolts: Double;
Public LegalVoltageBases: pDoubleArray;
Public GeneratorDispatchReference: Double;
Public DefaultGrowthFactor: Double;
Public DefaultGrowthRate: Double;
Public GenMultiplier: Double;
Public HarmMult: Double;
Public DefaultHourMult: Complex;
Public PriceSignal: Double;
Public RegisterTotals: TRegisterArray;
Public DefaultDailyShapeObj: TLoadShapeObj;
Public DefaultYearlyShapeObj: TLoadShapeObj;
Public CurrentDirectory: String;
Public ReductionStrategy: TReductionStrategy;
Public ReductionZmag: Double;
Public ReduceLateralsKeepLoad: Boolean;
Public ReductionStrategyString: String;
Public PctNormalFactor: Double;
Public NodeMarkerCode: Integer;
Public NodeMarkerWidth: Integer;
Public SwitchMarkerCode: Integer;
Public TransMarkerSize: Integer;
Public CapMarkerSize: Integer;
Public RegMarkerSize: Integer;
Public PVMarkerSize: Integer;
Public StoreMarkerSize: Integer;
Public FuseMarkerSize: Integer;
Public RecloserMarkerSize: Integer;
Public RelayMarkerSize: Integer;
Public TransMarkerCode: Integer;
Public CapMarkerCode: Integer;
Public RegMarkerCode: Integer;
Public PVMarkerCode: Integer;
Public StoreMarkerCode: Integer;
Public FuseMarkerCode: Integer;
Public RecloserMarkerCode: Integer;
Public RelayMarkerCode: Integer;
Public MarkSwitches: Boolean;
Public MarkTransformers: Boolean;
Public MarkCapacitors: Boolean;
Public MarkRegulators: Boolean;
Public MarkPVSystems: Boolean;
Public MarkStorage: Boolean;
Public MarkFuses: Boolean;
Public MarkReclosers: Boolean;
Public MarkRelays: Boolean;
Public BusMarkerList: TList;
Public ActiveLoadShapeClass: Integer;

Methods

Public constructor Create(dssContext: TDSSContext; const aName: String);
Public destructor Destroy; OVERRIDE;
Public procedure AddCktElement(Obj: TDSSCktElement);
Public procedure ClearBusMarkers;
Public procedure TotalizeMeters;
Public function ComputeCapacity: Boolean;
Public function Save(Dir: String): Boolean;
Public procedure ProcessBusDefs;
Public procedure ReProcessBusDefs;
Public procedure DoResetMeterZones;
Public function SetElementActive(const FullObjectName: String): Integer;
Public procedure InvalidateAllPCElements;
Public procedure DebugDump(var F: TFileStream);
Public function GetTopology: TCktTree;
Public procedure FreeTopology;
Public function GetBusAdjacentPDLists: TAdjArray;
Public function GetBusAdjacentPCLists: TAdjArray;
Public function getPCEatBus(BusName: String; useNone: Boolean = TRUE): ArrayOfString;
Public function getPDEatBus(BusName: String; useNone: Boolean = TRUE): ArrayOfString;
Public function ReportPCEatBus(BusName: String): String;
Public function ReportPDEatBus(BusName: String): String;

Properties

Public property Name: String READ Get_Name;
Public property CaseName: String READ FCaseName WRITE Set_CaseName;
Public property ActiveCktElement: TDSSCktElement READ FActiveCktElement WRITE Set_ActiveCktElement;
Public property Losses: Complex READ Get_Losses;
Public property BusNameRedefined: Boolean READ FBusNameRedefined WRITE Set_BusNameRedefined;
Public property LoadMultiplier: Double READ FLoadMultiplier WRITE Set_LoadMultiplier;

Description

Fields

Public DSS: TDSSContext;
 
Public ActiveBusIndex: Integer;
 
Public Fundamental: Double;
 
Public Control_BusNameRedefined: Boolean;

fundamental and default base frequency

Public BusList: TBusHashListType;

Flag for use by control elements to detect redefinition of buses

Public AutoAddBusList: TBusHashListType;

Flag for use by control elements to detect redefinition of buses

Public DeviceList: THashList;
 
Public Faults: TDSSPointerList;

lists of pointers to different elements by class

Public PDElements: TDSSPointerList;

lists of pointers to different elements by class

Public PCElements: TDSSPointerList;

lists of pointers to different elements by class

Public DSSControls: TDSSPointerList;

lists of pointers to different elements by class

Public Sources: TDSSPointerList;

lists of pointers to different elements by class

Public MeterElements: TDSSPointerList;

lists of pointers to different elements by class

Public Sensors: TDSSPointerList;

lists of pointers to different elements by class

Public Monitors: TDSSPointerList;

lists of pointers to different elements by class

Public EnergyMeters: TDSSPointerList;

lists of pointers to different elements by class

Public Generators: TDSSPointerList;

lists of pointers to different elements by class

Public StorageElements: TDSSPointerList;

lists of pointers to different elements by class

Public PVSystems: TDSSPointerList;

lists of pointers to different elements by class

Public Substations: TDSSPointerList;

lists of pointers to different elements by class

Public Transformers: TDSSPointerList;

lists of pointers to different elements by class

Public AutoTransformers: TDSSPointerList;

lists of pointers to different elements by class

Public CapControls: TDSSPointerList;

lists of pointers to different elements by class

Public RegControls: TDSSPointerList;

lists of pointers to different elements by class

Public Lines: TDSSPointerList;

lists of pointers to different elements by class

Public Loads: TDSSPointerList;

lists of pointers to different elements by class

Public ShuntCapacitors: TDSSPointerList;

lists of pointers to different elements by class

Public Reactors: TDSSPointerList;

lists of pointers to different elements by class

Public Relays: TDSSPointerList;

added for CIM XML export

Public Fuses: TDSSPointerList;

added for CIM XML export

Public Reclosers: TDSSPointerList;

added for CIM XML export

Public InvControls: TDSSPointerList;

added for CIM XML export

Public ExpControls: TDSSPointerList;

added for CIM XML export

Public SwtControls: TDSSPointerList;

added for CIM XML export

Public CktElements: TDSSPointerList;
 
Public IncrCktElements: TDSSPointerList;
 
Public LockIc: TCriticalSection;
 
Public ControlQueue: TControlQueue;
 
Public Solution: TSolutionObj;
 
Public AutoAddObj: TAutoAdd;
 
Public UEWeight: Double;

For AutoAdd stuff

Public LossWeight: Double;

For AutoAdd stuff

Public NumUEregs: Integer;
 
Public NumLossRegs: Integer;
 
Public Ueregs: pIntegerArray;
 
Public LossRegs: pIntegerArray;
 
Public CapacityStart: Double;
 
Public CapacityIncrement: Double;
 
Public TrapezoidalIntegration: Boolean;
 
Public LogEvents: Boolean;
 
Public LoadDurCurve: String;
 
Public LoadDurCurveObj: TLoadShapeObj;
 
Public PriceCurve: String;
 
Public PriceCurveObj: TPriceShapeObj;
 
Public NumDevices: Integer;
 
Public NumBuses: Integer;
 
Public NumNodes: Integer;
 
Public MaxDevices: Integer;
 
Public MaxBuses: Integer;
 
Public MaxNodes: Integer;
 
Public IncDevices: Integer;
 
Public IncBuses: Integer;
 
Public IncNodes: Integer;
 
Public Buses: pTBusArray;

Bus and Node stuff

Public MapNodeToBus: pTNodeBusArray;
 
Public Issolved: Boolean;

Flags

Public DuplicatesAllowed: Boolean;
 
Public ZonesLocked: Boolean;
 
Public MeterZonesComputed: Boolean;
 
Public PositiveSequence: Boolean;
 
Public NeglectLoadY: Boolean;

Model is to be interpreted as Pos seq

Public NormalMinVolts: Double;

Voltage limits

Public NormalMaxVolts: Double;

Voltage limits

Public EmergMaxVolts: Double;

Voltage limits

Public EmergMinVolts: Double;

Voltage limits

Public LegalVoltageBases: pDoubleArray;

per unit voltage restraints for this circuit

Public GeneratorDispatchReference: Double;

Global circuit multipliers

Public DefaultGrowthFactor: Double;

Global circuit multipliers

Public DefaultGrowthRate: Double;

Global circuit multipliers

Public GenMultiplier: Double;

Global circuit multipliers

Public HarmMult: Double;

global multiplier for every generator

Public DefaultHourMult: Complex;
 
Public PriceSignal: Double;
 
Public RegisterTotals: TRegisterArray;

price signal for entire circuit EnergyMeter Totals

Public DefaultDailyShapeObj: TLoadShapeObj;
 
Public DefaultYearlyShapeObj: TLoadShapeObj;
 
Public CurrentDirectory: String;
 
Public ReductionStrategy: TReductionStrategy;
 
Public ReductionZmag: Double;
 
Public ReduceLateralsKeepLoad: Boolean;
 
Public ReductionStrategyString: String;
 
Public PctNormalFactor: Double;
 
Public NodeMarkerCode: Integer;

——Plot Marker Circuit Globals———

Public NodeMarkerWidth: Integer;
 
Public SwitchMarkerCode: Integer;
 
Public TransMarkerSize: Integer;
 
Public CapMarkerSize: Integer;
 
Public RegMarkerSize: Integer;
 
Public PVMarkerSize: Integer;
 
Public StoreMarkerSize: Integer;
 
Public FuseMarkerSize: Integer;
 
Public RecloserMarkerSize: Integer;
 
Public RelayMarkerSize: Integer;
 
Public TransMarkerCode: Integer;
 
Public CapMarkerCode: Integer;
 
Public RegMarkerCode: Integer;
 
Public PVMarkerCode: Integer;
 
Public StoreMarkerCode: Integer;
 
Public FuseMarkerCode: Integer;
 
Public RecloserMarkerCode: Integer;
 
Public RelayMarkerCode: Integer;
 
Public MarkSwitches: Boolean;
 
Public MarkTransformers: Boolean;
 
Public MarkCapacitors: Boolean;
 
Public MarkRegulators: Boolean;
 
Public MarkPVSystems: Boolean;
 
Public MarkStorage: Boolean;
 
Public MarkFuses: Boolean;
 
Public MarkReclosers: Boolean;
 
Public MarkRelays: Boolean;
 
Public BusMarkerList: TList;
 
Public ActiveLoadShapeClass: Integer;

list of buses to mark ———————————

Methods

Public constructor Create(dssContext: TDSSContext; const aName: String);

Variables for the tearing Algorithm

Public destructor Destroy; OVERRIDE;
 
Public procedure AddCktElement(Obj: TDSSCktElement);
 
Public procedure ClearBusMarkers;
 
Public procedure TotalizeMeters;
 
Public function ComputeCapacity: Boolean;
 
Public function Save(Dir: String): Boolean;
 
Public procedure ProcessBusDefs;
 
Public procedure ReProcessBusDefs;
 
Public procedure DoResetMeterZones;
 
Public function SetElementActive(const FullObjectName: String): Integer;
 
Public procedure InvalidateAllPCElements;
 
Public procedure DebugDump(var F: TFileStream);
 
Public function GetTopology: TCktTree;

Access to topology from the first source

Public procedure FreeTopology;
 
Public function GetBusAdjacentPDLists: TAdjArray;
 
Public function GetBusAdjacentPCLists: TAdjArray;
 
Public function getPCEatBus(BusName: String; useNone: Boolean = TRUE): ArrayOfString;
 
Public function getPDEatBus(BusName: String; useNone: Boolean = TRUE): ArrayOfString;
 
Public function ReportPCEatBus(BusName: String): String;
 
Public function ReportPDEatBus(BusName: String): String;
 

Properties

Public property Name: String READ Get_Name;
 
Public property CaseName: String READ FCaseName WRITE Set_CaseName;
 
Public property ActiveCktElement: TDSSCktElement READ FActiveCktElement WRITE Set_ActiveCktElement;
 
Public property Losses: Complex READ Get_Losses;
 
Public property BusNameRedefined: Boolean READ FBusNameRedefined WRITE Set_BusNameRedefined;

Total Circuit PD Element losses

Public property LoadMultiplier: Double READ FLoadMultiplier WRITE Set_LoadMultiplier;
 
Generated by PasDoc 0.16.0.