zaber.motion.ascii.DeviceIdentity Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of motion-library Show documentation
A library that aims to provide easy-to-use API for communication with Zaber devices using Zaber ASCII Protocol.
There is a newer version: 6.7.0
// ===== THIS FILE IS GENERATED FROM A TEMPLATE ===== //
// ============== DO NOT EDIT DIRECTLY ============== //

package zaber.motion.ascii;

import zaber.motion.FirmwareVersion;
import zaber.motion.protobufs.Main;

/**
 * Representation of data gathered during device identification.
 */
public final class DeviceIdentity {

    private int deviceId;

    /**
     * Unique ID of the device hardware.
     */
    public void setDeviceId(int deviceId) {
        this.deviceId = deviceId;
    }

    /**
     * @return Unique ID of the device hardware.
     */
    public int getDeviceId() {
        return this.deviceId;
    }

    private long serialNumber;

    /**
     * Serial number of the device.
     */
    public void setSerialNumber(long serialNumber) {
        this.serialNumber = serialNumber;
    }

    /**
     * @return Serial number of the device.
     */
    public long getSerialNumber() {
        return this.serialNumber;
    }

    private String name;

    /**
     * Name of the product.
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * @return Name of the product.
     */
    public String getName() {
        return this.name;
    }

    private int axisCount;

    /**
     * Number of axes this device has.
     */
    public void setAxisCount(int axisCount) {
        this.axisCount = axisCount;
    }

    /**
     * @return Number of axes this device has.
     */
    public int getAxisCount() {
        return this.axisCount;
    }

    private FirmwareVersion firmwareVersion;

    /**
     * Version of the firmware.
     */
    public void setFirmwareVersion(FirmwareVersion firmwareVersion) {
        this.firmwareVersion = firmwareVersion;
    }

    /**
     * @return Version of the firmware.
     */
    public FirmwareVersion getFirmwareVersion() {
        return this.firmwareVersion;
    }

    private boolean isModified;

    /**
     * The device has hardware modifications.
     */
    public void setIsModified(boolean isModified) {
        this.isModified = isModified;
    }

    /**
     * @return The device has hardware modifications.
     */
    public boolean getIsModified() {
        return this.isModified;
    }

    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("DeviceIdentity { ");
        sb.append("deviceId: ");
        sb.append(this.deviceId);
        sb.append(", ");
        sb.append("serialNumber: ");
        sb.append(this.serialNumber);
        sb.append(", ");
        sb.append("name: ");
        sb.append(this.name);
        sb.append(", ");
        sb.append("axisCount: ");
        sb.append(this.axisCount);
        sb.append(", ");
        sb.append("firmwareVersion: ");
        sb.append(this.firmwareVersion);
        sb.append(", ");
        sb.append("isModified: ");
        sb.append(this.isModified);
        sb.append(" }");
        return sb.toString();
    }

    public static DeviceIdentity fromProtobuf(Main.DeviceIdentity pbData) {
        DeviceIdentity obj = new DeviceIdentity();
        obj.setDeviceId(pbData.getDeviceId());
        obj.setSerialNumber(pbData.getSerialNumber());
        obj.setName(pbData.getName());
        obj.setAxisCount(pbData.getAxisCount());
        obj.setFirmwareVersion(FirmwareVersion.fromProtobuf(pbData.getFirmwareVersion()));
        obj.setIsModified(pbData.getIsModified());
        return obj;
    }
}