com.powsybl.openrao.data.cneexportercommons.CneExporterParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of open-rao-cne-exporter-commons Show documentation
Contains classes useful to all CNE exporters
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/.
 */

package com.powsybl.openrao.data.cneexportercommons;

/**
 * Parameters for CNE export
 *
 * @author Peter Mitri {@literal }
 */
public class CneExporterParameters {
    private String documentId;
    private int revisionNumber;
    private String domainId;
    private ProcessType processType;
    private String senderId;
    private RoleType senderRole;
    private String receiverId;
    private RoleType receiverRole;
    private String timeInterval;

    public enum RoleType {
        CAPACITY_COORDINATOR("A36"),
        REGIONAL_SECURITY_COORDINATOR("A44"),
        SYSTEM_OPERATOR("A04");

        private String code;
        private RoleType(String code) {
            this.code = code;
        }

        public String getCode() {
            return code;
        }

        @Override
        public String toString() {
            return getCode();
        }
    }

    public enum ProcessType {
        DAY_AHEAD_CC("A48"), // Day-ahead capacity determination
        Z01("Z01"); // Day-ahead capacity determination for SWE, does not exist in xsd

        private String code;
        private ProcessType(String code) {
            this.code = code;
        }

        public String getCode() {
            return code;
        }

        @Override
        public String toString() {
            return getCode();
        }
    }

    public CneExporterParameters(String documentId, int revisionNumber, String domainId, ProcessType processType, String senderId, RoleType senderRole, String receiverId, RoleType receiverRole, String timeInterval) {
        this.documentId = documentId;
        this.revisionNumber = revisionNumber;
        this.domainId = domainId;
        this.processType = processType;
        this.senderId = senderId;
        this.senderRole = senderRole;
        this.receiverId = receiverId;
        this.receiverRole = receiverRole;
        this.timeInterval = timeInterval;
    }

    public String getDocumentId() {
        return documentId;
    }

    public int getRevisionNumber() {
        return revisionNumber;
    }

    public String getDomainId() {
        return domainId;
    }

    public ProcessType getProcessType() {
        return processType;
    }

    public String getSenderId() {
        return senderId;
    }

    public RoleType getSenderRole() {
        return senderRole;
    }

    public String getReceiverId() {
        return receiverId;
    }

    public RoleType getReceiverRole() {
        return receiverRole;
    }

    public String getTimeInterval() {
        return timeInterval;
    }
}