org.apache.plc4x.java.abeth.readwrite.CIPEncapsulationPacket Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of plc4j-driver-ab-eth Show documentation
Implementation of a PLC4X driver able to speak using the Allen Bradley AB-ETH 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.abeth.readwrite;

import org.apache.plc4x.java.abeth.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.utils.Message;

import java.util.Objects;
import java.math.BigInteger;

@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "className")
public abstract class CIPEncapsulationPacket implements Message {


    // Properties.
    private final long sessionHandle;
    private final long status;
    private final short[] senderContext;
    private final long options;

    @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
    public CIPEncapsulationPacket(@JsonProperty("sessionHandle") long sessionHandle, @JsonProperty("status") long status, @JsonProperty("senderContext") short[] senderContext, @JsonProperty("options") long options) {
        this.sessionHandle = sessionHandle;
        this.status = status;
        this.senderContext = senderContext;
        this.options = options;
    }

    public abstract Object[] getDiscriminatorValues();

    public long getSessionHandle() {
        return sessionHandle;
    }

    public long getStatus() {
        return status;
    }

    public short[] getSenderContext() {
        return senderContext;
    }

    public long getOptions() {
        return options;
    }

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

        // Discriminator Field (commandType)
        lengthInBits += 16;

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

        // Simple field (sessionHandle)
        lengthInBits += 32;

        // Simple field (status)
        lengthInBits += 32;

        // Array field
        lengthInBits += 8 * senderContext.length;

        // Simple field (options)
        lengthInBits += 32;

        // Reserved Field
        lengthInBits += 32;

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

        return lengthInBits / 8;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof CIPEncapsulationPacket)) {
            return false;
        }
        CIPEncapsulationPacket that = (CIPEncapsulationPacket) o;
        return
            (getSessionHandle() == that.getSessionHandle()) &&
            (getStatus() == that.getStatus()) &&
            (getSenderContext() == that.getSenderContext()) &&
            (getOptions() == that.getOptions()) &&
            true;
    }

    @Override
    public int hashCode() {
        return Objects.hash(
            getSessionHandle(),
            getStatus(),
            getSenderContext(),
            getOptions()
        );
    }

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

    public String toString(ToStringStyle style) {
        return new ToStringBuilder(this, style)
            .append("sessionHandle", getSessionHandle())
            .append("status", getStatus())
            .append("senderContext", getSenderContext())
            .append("options", getOptions())
            .toString();
    }

}