ImpedanceRecords Module¶
This module contains all Harmonic Impedance record information for passing data to and from the ERACS Harmonic Impedance calculation engine.
-
class
THZSetUpData
(*args)¶ The setup object for Harmonic Impedance. This class contains the record structure which is passed to the Harmonic Impedance module.
- Inherits
-
property
StudyTitle
¶ Harmonic Impedance study title.
- Type
str.
- Writable
True.
-
property
StudyType
¶ Harmonic Impedance study type (harmonic survey? 0 = No, 1 = Yes).
- Type
int.
- Writable
True.
-
property
HarmOff
¶ Harmonic Offset for study.
- Type
float.
- Writable
True.
-
property
HarmMin
¶ Lowest harmonic.
- Type
float.
- Writable
True.
-
property
HarmMax
¶ Highest harmonic.
- Type
float.
- Writable
True.
-
property
HarmInt
¶ Harmonic intervals.
- Type
float.
- Writable
True.
-
property
OutputUnits
¶ The output units of the Harmonic Impedance study.
- Type
int.
- Writable
True.
-
property
InjectionBus
¶ Sequence number of the Injection busbar.
- Type
int.
- Writable
True.
-
SetDefaults
()¶ Sets the default values for all setup data for the Harmonic Impedance study, this sets the values in the underlying ctypes record structure.
- Raises
TEracsDataError – If missing keys.
-
class
TImpedanceProfileData
(*args)¶ The impedance profile data object for Grids and Shunts. This class contains the record structure which is passed to the Harmonic Impedance module, and exposes all relevant properties.
- Inherits
-
property
pSeqNum
¶ Profile parent sequence number (element the impedance profile is associated with).
- Type
str.
- Writable
True.
-
property
pTypeCode
¶ Profile parent type code (element the impedance profile is associated with).
- Type
int.
- Writable
True.
-
property
ConvInd
¶ Impedance conversion indicator, possible values are… (0 = Ohms, 1 = pu on system base, 2 = percentage on system base).
- Type
int.
- Writable
True.
-
property
NumValues
¶ Number of harmonic impedance profiles.
- Type
int.
- Writable
True.
-
property
Profile
¶ The profiles associated with this impedance profile record.
- Type
Array.
- Writeable
False.
-
SetDefaults
()¶ Sets the default values for the harmonic impedance profile data.
-
LoadFromDict
(AParentDict)¶ An impedance profile dictionary is passed in and desired key-value pairs are used to populate certain data fields within the record.
- Parameters
AParentDict (dict) – The parent dictionary which contains seqnum and typecode, as well as embedded impedance profile data.
- Returns
None
- Raises
TEracsDataError – If the winding dictionary is missing required keys.
-
class
THZSummaryResults
(*args)¶ Summary results for the Harmonic Impedance study.
- Inherits
-
class
THZBusbarResult
(*args)¶ Busbar results for the Harmonic Impedance study.