• Home
• com.powsybl
• powsybl-iidm-serde
• 6.5.0-RC1
• source code
• DiscreteMeasurementsSerDe.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.powsybl.iidm.serde.extensions.DiscreteMeasurementsSerDe Maven / Gradle / Ivy

/**
 * Copyright (c) 2021, 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.iidm.serde.extensions;

import com.google.auto.service.AutoService;
import com.powsybl.commons.PowsyblException;
import com.powsybl.commons.extensions.AbstractExtensionSerDe;
import com.powsybl.commons.extensions.ExtensionSerDe;
import com.powsybl.commons.io.DeserializerContext;
import com.powsybl.commons.io.SerializerContext;
import com.powsybl.commons.io.TreeDataReader;
import com.powsybl.commons.io.TreeDataWriter;
import com.powsybl.iidm.network.Identifiable;
import com.powsybl.iidm.network.extensions.DiscreteMeasurement;
import com.powsybl.iidm.network.extensions.DiscreteMeasurementAdder;
import com.powsybl.iidm.network.extensions.DiscreteMeasurements;
import com.powsybl.iidm.network.extensions.DiscreteMeasurementsAdder;

import java.util.Map;

/**
 * @author Miora Ralambotiana {@literal }
 */
@AutoService(ExtensionSerDe.class)
public class DiscreteMeasurementsSerDe> extends AbstractExtensionSerDe> {

    private static final String DISCRETE_MEASUREMENT_ROOT = "discreteMeasurement";
    private static final String DISCRETE_MEASUREMENT_ARRAY = "discreteMeasurements";
    private static final String VALUE = "value";
    public static final String PROPERTY_ROOT = "property";
    private static final String PROPERTY_ARRAY = "properties";

    public DiscreteMeasurementsSerDe() {
        super(DISCRETE_MEASUREMENT_ARRAY, "network", DiscreteMeasurements.class,
                "discreteMeasurements.xsd", "http://www.powsybl.org/schema/iidm/ext/discrete_measurements/1_0", "dm");
    }

    @Override
    public Map getArrayNameToSingleNameMap() {
        return Map.of(DISCRETE_MEASUREMENT_ARRAY, DISCRETE_MEASUREMENT_ROOT,
                PROPERTY_ARRAY, PROPERTY_ROOT);
    }

    @Override
    public void write(DiscreteMeasurements extension, SerializerContext context) {
        TreeDataWriter writer = context.getWriter();
        writer.writeStartNodes();
        for (DiscreteMeasurement discreteMeasurement : extension.getDiscreteMeasurements()) {
            writer.writeStartNode(getNamespaceUri(), DISCRETE_MEASUREMENT_ROOT);
            writer.writeStringAttribute("id", discreteMeasurement.getId());
            writer.writeEnumAttribute("type", discreteMeasurement.getType());
            writer.writeEnumAttribute("tapChanger", discreteMeasurement.getTapChanger());
            writer.writeEnumAttribute("valueType", discreteMeasurement.getValueType());
            switch (discreteMeasurement.getValueType()) {
                case BOOLEAN -> writer.writeBooleanAttribute(VALUE, discreteMeasurement.getValueAsBoolean());
                case INT -> writer.writeIntAttribute(VALUE, discreteMeasurement.getValueAsInt());
                case STRING -> writer.writeStringAttribute(VALUE, discreteMeasurement.getValueAsString());
            }
            writer.writeBooleanAttribute("valid", discreteMeasurement.isValid());

            writer.writeStartNodes();
            for (String name : discreteMeasurement.getPropertyNames()) {
                writer.writeStartNode(getNamespaceUri(), PROPERTY_ROOT);
                writer.writeStringAttribute("name", name);
                writer.writeStringAttribute(VALUE, discreteMeasurement.getProperty(name));
                writer.writeEndNode();
            }
            writer.writeEndNodes();

            writer.writeEndNode();
        }
        writer.writeEndNodes();
    }

    @Override
    public DiscreteMeasurements read(I extendable, DeserializerContext context) {
        DiscreteMeasurementsAdder adder = extendable.newExtension(DiscreteMeasurementsAdder.class);
        DiscreteMeasurements discreteMeasurements = adder.add();
        context.getReader().readChildNodes(elementName -> {
            if (elementName.equals(DISCRETE_MEASUREMENT_ROOT)) {
                readDiscreteMeasurement(discreteMeasurements, context.getReader());
            } else {
                throw new PowsyblException("Unknown element name '" + elementName + "' in 'discreteMeasurements'");
            }
        });
        return discreteMeasurements;
    }

    private static > void readDiscreteMeasurement(DiscreteMeasurements discreteMeasurements, TreeDataReader reader) {
        String id = reader.readStringAttribute("id");
        DiscreteMeasurement.Type type = reader.readEnumAttribute("type", DiscreteMeasurement.Type.class);
        DiscreteMeasurement.TapChanger tapChanger = reader.readEnumAttribute("tapChanger", DiscreteMeasurement.TapChanger.class);
        DiscreteMeasurement.ValueType valueType = reader.readEnumAttribute("valueType", DiscreteMeasurement.ValueType.class);

        DiscreteMeasurementAdder adder = discreteMeasurements.newDiscreteMeasurement()
                .setId(id)
                .setType(type)
                .setTapChanger(tapChanger);
        switch (valueType) {
            case BOOLEAN -> adder.setValue(reader.readBooleanAttribute(VALUE));
            case INT -> adder.setValue(reader.readIntAttribute(VALUE));
            case STRING -> adder.setValue(reader.readStringAttribute(VALUE));
        }

        adder.setValid(reader.readBooleanAttribute("valid", true));

        reader.readChildNodes(elementName -> {
            if (elementName.equals(PROPERTY_ROOT)) {
                adder.putProperty(reader.readStringAttribute("name"),
                        reader.readStringAttribute(VALUE));
                reader.readEndNode();
            } else {
                throw new PowsyblException("Unknown element name '" + elementName + "' in 'discreteMeasurement'");
            }
        });
        adder.add();
    }

    @Override
    public boolean isSerializable(DiscreteMeasurements extension) {
        return !extension.getDiscreteMeasurements().isEmpty();
    }
}