org.apache.plc4x.java.s7.readwrite.S7Message Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plc4j-driver-s7 Show documentation
Implementation of a PLC4X driver for the classic Step7 S7 protocol.
There is a newer version: 0.12.0
/*
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
*/

package org.apache.plc4x.java.s7.readwrite;

import static org.apache.plc4x.java.spi.generation.StaticHelper.*;

import org.apache.plc4x.java.s7.readwrite.io.*;
import org.apache.plc4x.java.s7.readwrite.types.*;

import com.fasterxml.jackson.annotation.*;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import org.apache.plc4x.java.api.value.*;
import org.apache.plc4x.java.spi.generation.Message;
import org.apache.plc4x.java.spi.generation.MessageIO;

import java.time.*;
import java.util.*;
import java.math.BigInteger;

@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, property = "className")
public abstract class S7Message implements Message {


    // Constant values.
    public static final short PROTOCOLID = 0x32;

    // Properties.
    private final int tpduReference;
    private final S7Parameter parameter;
    private final S7Payload payload;

    @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
    public S7Message(@JsonProperty("tpduReference") int tpduReference, @JsonProperty("parameter") S7Parameter parameter, @JsonProperty("payload") S7Payload payload) {
        this.tpduReference = tpduReference;
        this.parameter = parameter;
        this.payload = payload;
    }

    public abstract Object[] getDiscriminatorValues();

    public int getTpduReference() {
        return tpduReference;
    }

    public S7Parameter getParameter() {
        return parameter;
    }

    public S7Payload getPayload() {
        return payload;
    }

    @Override
    @JsonIgnore
    public int getLengthInBytes() {
        return getLengthInBits() / 8;
    }

    @Override
    @JsonIgnore
    public int getLengthInBits() {
        int lengthInBits = 0;

        // Const Field (protocolId)
        lengthInBits += 8;

        // Discriminator Field (messageType)
        lengthInBits += 8;

        // Reserved Field
        lengthInBits += 16;

        // Simple field (tpduReference)
        lengthInBits += 16;

        // Implicit Field (parameterLength)
        lengthInBits += 16;

        // Implicit Field (payloadLength)
        lengthInBits += 16;

        // Length of sub-type elements will be added by sub-type...

        // Optional Field (parameter)
        if(parameter != null) {
            lengthInBits += parameter.getLengthInBits();
        }

        // Optional Field (payload)
        if(payload != null) {
            lengthInBits += payload.getLengthInBits();
        }

        return lengthInBits;
    }

    public PlcValue toPlcValue() {
        Map fieldValues = new TreeMap<>();

        fieldValues.put("tpduReference", PlcValues.of(tpduReference));

        if(parameter != null) {
            fieldValues.put("parameter", parameter.toPlcValue());
        } else {
            fieldValues.put("parameter", null);
        }

        if(payload != null) {
            fieldValues.put("payload", payload.toPlcValue());
        } else {
            fieldValues.put("payload", null);
        }

        return new PlcStruct(fieldValues);
    }

    @Override
    @JsonIgnore
    public MessageIO getMessageIO() {
        return new S7MessageIO();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof S7Message)) {
            return false;
        }
        S7Message that = (S7Message) o;
        return
            (getTpduReference() == that.getTpduReference()) &&
            (getParameter() == that.getParameter()) &&
            (getPayload() == that.getPayload()) &&
            true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(
            getTpduReference(),
            getParameter(),
            getPayload()
        );
    }

    @Override
    public String toString() {
        return toString(ToStringStyle.SHORT_PREFIX_STYLE);
    }

    public String toString(ToStringStyle style) {
        return new ToStringBuilder(this, style)
            .append("tpduReference", getTpduReference())
            .append("parameter", getParameter())
            .append("payload", getPayload())
            .toString();
    }

}