com.powsybl.powerfactory.model.Project Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powsybl-powerfactory-model Show documentation
PowerFactory data model
The newest version!
/**
 * Copyright (c) 2022, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.powerfactory.model;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.powsybl.commons.json.JsonUtil;

import java.io.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.Instant;
import java.util.List;
import java.util.Objects;

/**
 * @author Geoffroy Jamgotchian {@literal }
 */
public class Project extends AbstractPowerFactoryData {

    private final DataObject rootObject;

    public Project(String name, DataObject rootObject, DataObjectIndex index) {
        super(name, index);
        this.rootObject = Objects.requireNonNull(rootObject);
    }

    public DataObject getRootObject() {
        return rootObject;
    }

    static class ParsingContext {
        String name;

        final DataObjectIndex index = new DataObjectIndex();

        DataScheme scheme;

        DataObject rootObject;
    }

    static Project parseJson(JsonParser parser) {
        ParsingContext context = new ParsingContext();
        try {
            parser.nextToken();
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
        JsonUtil.parseObject(parser, fieldName -> {
            switch (fieldName) {
                case "name":
                    context.name = parser.nextTextValue();
                    return true;
                case "classes":
                    context.scheme = DataScheme.parseJson(parser);
                    return true;
                case "rootObject":
                    parser.nextToken();
                    context.rootObject = DataObject.parseJson(parser, context.index, context.scheme);
                    return true;
                default:
                    return false;
            }
        });
        return new Project(context.name, context.rootObject, context.index);
    }

    public static Project parseJson(Reader reader) {
        return JsonUtil.parseJson(reader, Project::parseJson);
    }

    public static Project readJson(Path file) {
        try (BufferedReader reader = Files.newBufferedReader(file, StandardCharsets.UTF_8)) {
            return parseJson(reader);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

    @Override
    public void writeJson(JsonGenerator generator) throws IOException {
        generator.writeStartObject();

        generator.writeStringField("name", name);

        DataScheme scheme = DataScheme.build(rootObject);
        scheme.writeJson(generator);

        generator.writeFieldName("rootObject");
        rootObject.writeJson(generator);

        generator.writeEndObject();
    }

    /**
     * Get active study case.
     * Following layout is expected:
     * MyProject.IntPrj
     *     pCase (OBJECT)
     *     'Study Cases'.IntPrjfolder
     *         MyStudyCase.Intcase
     *             iStudyTime (INTEGER64)
     *     'Network Model'.IntPrjfolder
     *         'Network Data'.IntPrjfolder
     *             MyNetwork1.ElmNet
     *             MyNetwork2.ElmNet
     *             ...
     * @return the active study case
     */
    public StudyCase getActiveStudyCase() {
        // get active study case
        DataObject studyCaseObj = rootObject.getObjectAttributeValue("pCase").resolve().orElseThrow();
        Instant studyTime = Instant.ofEpochSecond(studyCaseObj.getLongAttributeValue("iStudyTime"));
        String studyCaseName = rootObject.getLocName() + " - " + studyCaseObj.getLocName();
        DataObject netDataObj = rootObject.getChild("Network Model", "Network Data").orElseThrow();
        List elmNets = netDataObj.getChildrenByClass("ElmNet");
        // TODO apply network variations and operational scenarios
        return new StudyCase(studyCaseName, studyTime, elmNets, index);
    }
}