001/*
002 * Copyright (C) Photon Vision.
003 *
004 * This program is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * This program is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU General Public License for more details.
013 *
014 * You should have received a copy of the GNU General Public License
015 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package org.photonvision.common.dataflow.structures;
019
020import edu.wpi.first.util.struct.Struct;
021
022public interface PacketSerde<T> {
023    int getMaxByteSize();
024
025    void pack(Packet packet, T value);
026
027    T unpack(Packet packet);
028
029    /** The name of this struct (eg "PhotonTrackedTarget") */
030    String getTypeName();
031
032    /**
033     * Gets the type string (e.g. for NetworkTables). This should be globally unique and start with
034     * "photonstruct:".
035     *
036     * @return type string
037     */
038    default String getTypeString() {
039        return "photonstruct:" + getTypeName() + ":" + getInterfaceUUID();
040    }
041
042    /** Gets the list of photonstruct types referenced by this struct. */
043    default PacketSerde<?>[] getNestedPhotonMessages() {
044        return new PacketSerde<?>[] {};
045    }
046
047    /** Gets the list of WPILib struct types referenced by this struct. */
048    default Struct<?>[] getNestedWpilibMessages() {
049        return new Struct<?>[] {};
050    }
051
052    /** The schema definition, as defined in photon-serde/README.md */
053    String getSchema();
054
055    /** The hash of the schema string */
056    String getInterfaceUUID();
057}