ArcFM Desktop Developer Guide
Import CYMDIST Results

Resource Center Home

Importing analysis results into ArcFM is optional functionality. Implement this only if you wish to view analysis results from CYMDIST in ArcMap. Importing results is the same whether the original data came directly from the GIS or from the Network Adapter database as a load case.

The most common calculations performed on a feeder loaded in CYMDIST are load allocation, load flow analysis, and short-circuit analysis. The Analysis API sends data as an XML file to the Implementation component. The Implementation component transforms the XML to comply with CYMDIST API standards and creates a Simulation object that provides the CYMDIST API with specific information about how the analysis is executed.


Interfaces:
    IMMXMLData
    IMMDistOpsWorkspace
    IMMAnalysisAPI

CoClasses:
    MMSelectionAnalysisAPI

The Implementation component configures the simulation by setting analysis parameters on the simulation object.

After it has executed analysis, the CYMDIST API returns results in an XML document. Each result value is identified by its keyword. The Implementation component provides these keywords to the CYMDIST API when executing the analysis. The CYMDIST API returns results in the XML for these keywords only. The following tables show the available keywords for Load Flow and Short Circuit Analysis.

Load Flow

Result Value

Units

Keywords

Voltage

kV

VBaseA, VBaseB, VBaseC

Voltage

kVLN

VLNA, VLNB, VLNC

Thru Current

Amps

IA, IB, IC

Loading

%

VA%, VB%, VC%

Thru Power

kW

KWA, KWB, KWC

Thru Power

kVAR

KVARA, KVARB, KVARC

Short-Circuit

Result Value

Units

Keywords

Three Phase Fault Current

Amps

LLLamp

Double Line to Ground Fault Current

Amps

LLGamp

Line to Line Fault Current

Amps

LLamp

Line to Ground Max. Fault Current

Amps

LGampMax

Line to Ground Min. Fault Current

Amps

LGampMin

Import analysis results by calling the appropriate import method on the IMMXMLData interface (depending on the type of XML file being imported). The Analysis API imports results into tables in the Network Adapter database. The name of the results table is based on the analysis type identified in the results XML, and the name of the feature class (as shown below). If you are importing load case results, specify the "TestCaseName" by including the TestCaseName property in the import properties.

   AnalysisType_FeatureClass
        TestCaseName_FeatureClass
                

The results for Transformers are stored in the table LoadFlow_Transformer or ShortCircuit_Transformer (depending on the type of analysis). Load cases are stored in LoadCase_Transformer.

Section Structure

CYMDIST returns all results in terms of "sections," which represent conductors. Refer to Chapter 1 – Getting Started (Section Structure page) of the CYMDIST online Reference Manual for details about section structure. A CYMDIST section corresponds to a distinct simple edge in an ArcFM conductor feature.

The CYMDIST API queries CYMDIST for results at the middle and end of each section. Each keyword returns two corresponding values for each section, IN and OUT. What each value represents depends on the type of result value that has been requested. Please refer to the following table.

Result Type

IN

OUT

Load Flow Voltages

voltage entering downstream device

voltage leaving downstream device

Load Flow Currents

current leaving upstream device

current entering downstream device

Short-Circuit Currents

current entering downstream device

current leaving downstream device

 

Many times the IN and OUT values for a keyword will be equal. Other times CYMDIST does not provide results for the end location on a section, so the OUT values are empty strings in the results XML.

The CYMDIST API can return results in terms of the conductor section, or in terms of the point feature at the end of the conductor section, or in terms of both. No results will be returned for conductor sections that are part of complex edges. These results are available only in terms of the point feature downstream of the section.

Displaying Results

The implementer decides how the results will be displayed to the user. For example, an XSL style sheet can be applied to the results XML to create an HTML report. You may also display the results in ArcMap. By importing the results XML to ArcFM through the Analysis API, the implementer makes result values available for labeling and custom symbology.

All results tables for an analysis type are created in the Network Adapter database the first time the results are imported for that analysis type. The implementer may add results tables to the map using the Add Data button.

You may display results in ArcMap by joining map layers to the results tables in the Network Adapter database, and then using labels or symbology.

After creating results layers for a feature class, the same feature may appear multiple times in the Attribute Editor when selected. To avoid confusion, you may wish to designate all results layers as not selectable.

 

 


Send Comment to ArcFMdocumentation@schneider-electric.com