com.zepben.evolve.services.common.translator.BaseProtoToCim.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation
SDK for interaction with the evolve platform
There is a newer version: 0.24.0rc1
/*
 * Copyright 2020 Zeppelin Bend Pty Ltd
 *
 * 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 https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.services.common.translator

import com.zepben.evolve.cim.iec61968.common.Document
import com.zepben.evolve.cim.iec61968.common.Organisation
import com.zepben.evolve.cim.iec61968.common.OrganisationRole
import com.zepben.evolve.cim.iec61970.base.core.IdentifiedObject
import com.zepben.evolve.cim.iec61970.base.core.NameType
import com.zepben.evolve.services.common.BaseService
import com.zepben.evolve.services.common.Resolvers
import com.zepben.evolve.services.common.extensions.internEmpty
import com.zepben.protobuf.cim.iec61968.common.Document as PBDocument
import com.zepben.protobuf.cim.iec61968.common.Organisation as PBOrganisation
import com.zepben.protobuf.cim.iec61968.common.OrganisationRole as PBOrganisationRole
import com.zepben.protobuf.cim.iec61970.base.core.IdentifiedObject as PBIdentifiedObject
import com.zepben.protobuf.cim.iec61970.base.core.NameType as PBNameType

//
// NOTE: Do not add base level extensions here, add them to the overriding services directly otherwise you will have import issues.
//

/************ IEC61968 COMMON ************/

fun toCim(pb: PBDocument, cim: Document, baseService: BaseService): Document =
    cim.apply {
        title = pb.title.internEmpty()
        createdDateTime = pb.createdDateTime.toInstant()
        authorName = pb.authorName.internEmpty()
        type = pb.type.internEmpty()
        status = pb.status.internEmpty()
        comment = pb.comment.internEmpty()
        toCim(pb.io, this, baseService)
    }

fun toCim(pb: PBOrganisation, baseService: BaseService): Organisation =
    Organisation(pb.mRID()).apply {
        toCim(pb.io, this, baseService)
    }

fun toCim(pb: PBOrganisationRole, cim: OrganisationRole, baseService: BaseService): OrganisationRole =
    cim.apply {
        baseService.resolveOrDeferReference(Resolvers.organisation(this), pb.organisationMRID)
        toCim(pb.io, this, baseService)
    }

/************ IEC61970 CORE ************/

fun toCim(pb: PBIdentifiedObject, cim: IdentifiedObject, baseService: BaseService): IdentifiedObject =
    cim.apply {
        name = pb.name.internEmpty()
        description = pb.description.internEmpty()
        numDiagramObjects = pb.numDiagramObjects
        pb.namesList.forEach { entry ->
            val nameType = baseService.getNameType(entry.type) ?: NameType(entry.type).also { baseService.addNameType(it) }
            this.addName(nameType, entry.name)
        }
    }

//
// NOTE: We always update the description in case the name type was created from the name embedded in an IdentifiedObject.
//
fun toCim(pb: PBNameType, baseService: BaseService): NameType =
    (baseService.getNameType(pb.name) ?: NameType(pb.name).also { baseService.addNameType(it) })
        .apply { description = pb.description }

abstract class BaseProtoToCim