Model Data Type

Model Property/Attribute Table
Property Name Xml Name Type Description
UniqueId Uid Guid A statistically unique identifier for the instance of the Model data type. Lazily instantiated.
InternalID ID Integer A non-zero, positive integer, unique identifier for the instance of the Model data type.
Number Number Integer A non-zero, positive integer, non-unique descriptor for the instance of the Model data type.
Acronym Acronym String An uppercase, non-unique acronym descriptor for the instance of the Model data type.
Name Name String A non-unique name descriptor for the instance of the Model data type.
Description Description String A non-unique description for the instance of the Model data type.
PhaseConfiguration PhaseConfiguration PhaseSelection Enumeration Defines whether the Model is interpreted as a three phase or positive sequence electrical network by either ThreePhase or PositiveSequence, respectively. Most users will model a positive sequence network and will therefore choose the PositiveSequence value. ThreePhase is only appropriate when all measured elements have an A, B, & C phasor value.
CurrentFlow-PostProcessingSetting CurrentFlow-PostProcessingSetting CurrentFlow-PostProcessingSetting Enumeration Defines how LSE results will be used to calculate current flow on series branches. ProcessOnly-MeasuredBranches tells the program to not perform the calculation for those lines that did not have at least one valid phasor value. ProcessBranches-ByNodeObservability uses the observation state of the from and to sides of the series branch to decide whether to perform the calculation.
CurrentInjection-PostProcessingSetting CurrentInjection-PostProcessingSetting CurrentInjection-PostProcessingSetting Enumeration Provides the same logic as the analagous setting for current flows but for shunt devices. ProcessOnlyMeasuredShunts will only compute an injection for shunts that had a measured injection. ProcessShuntsByNodeObservability will compute an injection for every shunt who's ConnectedNode is considered DirectlyObservable or IndirectlyObservable.
Accepts-Measurements Accepts-Measurements Boolean A flag that indicates whether the Model will accept values as inputs for keys defined for measured values when OnNewMeasurements() method is called.
Accepts-Estimates Accepts-Estimates Boolean A flag that indicates whether the Model will accept values as inputs for keys defined for estimated values when OnNewMeasurements() method is called.
Returns-StateEstimate Returns-StateEstimate Boolean A flag that indicates whether the Model will include the complex voltage output of the Linear State Estimator in the output measurements.
Returns-CurrentFlow Returns-CurrentFlow Boolean A flag that indicates whether the Model will include the current flows calculated from the output of the Linear State Estimator in the output measurements.
Returns-CurrentInjection Returns-CurrentInjection Boolean A flag that indicates whether the Model will include the current injections calculated from the output of the Linear State Estimator in the output measurements.
Returns-VoltageResiduals Returns-VoltageResiduals Boolean A flag that indicates whether the residual for voltage measurements will be included in the output measurements.
Returns-CurrentResiduals Returns-CurrentResiduals Boolean A flag that indicates whether the residual for the current measurements will be included in the output measurements.
Returns-CircuitBreakerStatus Returns-CircuitBreakerStatus Boolean A flag that indicates whether the prevailing status of the circuit breakers will be included in the output measurements.
Returns-SwitchStatus Returns-SwitchStatus Boolean A flag that indicates whether the prevailing status of the switches will be included in the output measurements.
ReturnsTapPositions ReturnsTapPositions Boolean A flag that indicates whether the prevailing tap position of the transformers will be included in the output measurements.


Last edited Sep 14, 2014 at 12:05 AM by kevinjones, version 4