FaultRecords Module
This module contains all Fault record information for passing data to and from the ERACS Fault calculation engine.
- class TFSetUpData(*args)
Fault setup data class, for passing basic Fault data to the Fault module such as study title and fault parameters (fault type, reactance option, etc.).
- Inherits
- property StudyTitle
Title for the Fault study.
- Type
str.
- Writable
True.
- property ReactOption
Fault study reactance option.
- Type
int.
- Writable
True.
- property FaultType
Study’s fault type.
- Type
int.
- Writable
True.
- property Typecode
Fault study target element typecode.
- Type
int.
- Writable
True.
- property SeqNum
Fault study target element sequence number.
- Type
int.
- Writable
True.
- property FaultPos
Position of fault along transmission line or cable.
- Type
int.
- Writable
True.
- property Rph
Fault phase resistance
- Type
int.
- Writable
True.
- property Xph
Fault phase reactance.
- Type
int.
- Writable
True.
- property Rgrnd
Fault ground phase resistance.
- Type
int.
- Writable
True.
- property Xgrnd
Fault ground phase reactance.
- Type
int.
- Writable
True.
- property IncMotor
Include motor contribution in Fault study.
- Type
int.
- Writable
True.
- SetDefaults()
Sets all setup data to default values.
- Raises
Global.TEracsDataError: If object has missing keys.
- class TFSummaryResults(*args)
Summary results class for the Fault study. Passed into the Fault DLL.
- Inherits
- property ResX
The X coordinate for the summary results box.
- Type
int.
- Writable
True.
- property ResY
The Y coordinate for the summary results box.
- Type
int.
- Writable
True.
- property Arrow
The arrow coordinates linking the fault location and the summary results box.
- Type
dict.
- Writable
False.
- StoreIntoDictionary(AOutputDictionary: dict, AFaultType: int)
Store all information from the underlying object into a dictionary.
- Parameters
AOutputDictionary (dict) – The dictionary to populate with field data.
- Raises
TEracsArgumentError – If first argument is not a dict.
- class TFBusbarResult(*args)
Busbar results class for Fault studies. Passed into the Fault DLL after a study has been performed.
- StoreIntoDictionary(AOutputDictionary: dict)
Store all information from the underlying object into a dictionary.
- Parameters
AOutputDictionary (dict) – The dictionary to populate with field data.
- Raises
TEracsArgumentError – If first argument is not a dict.
- class TFBranchResult(*args)
Branch results class for Fault studies. Passed into the Fault DLL after a study has been performed. Represents results for transmission lines, cables and series elements.
- StoreIntoDictionary(AOutputDictionary: dict)
Store all information from the underlying object into a dictionary.
- Parameters
AOutputDictionary (dict) – The dictionary to populate with field data.
- Raises
TEracsArgumentError – If first argument is not a dict.
- class TFNeutralResult(*args)
Neutral earth results class for Fault studies. Passed into the Fault DLL after a study has been performed.
- class TFOnePortResult(*args)
One port results class for Fault studies. Passed into the Fault DLL after a study has been performed. Represents grid infeeds, shunts, etc.
- StoreIntoDictionary(AOutputDictionary: dict)
Store all information from the underlying object into a dictionary.
- Parameters
AOutputDictionary (dict) – The dictionary to populate with field data.
- Raises
TEracsArgumentError – If first argument is not a dict.
- class TFTxResult(*args)
Transformer results class for Fault studies. Passed into the Fault DLL after a study has been performed.
- StoreIntoDictionary(AOutputDictionary: dict)
Store all information from the underlying object into a dictionary.
- Parameters
AOutputDictionary (dict) – The dictionary to populate with field data.
- Raises
TEracsArgumentError – If first argument is not a dict.