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
022@SuppressWarnings("doclint")
023public interface PacketSerde<T> {
024    int getMaxByteSize();
025
026    void pack(Packet packet, T value);
027
028    T unpack(Packet packet);
029
030    /** The name of this struct (eg "PhotonTrackedTarget") */
031    String getTypeName();
032
033    /**
034     * Gets the type string (e.g. for NetworkTables). This should be globally unique and start with
035     * "photonstruct:".
036     *
037     * @return type string
038     */
039    default String getTypeString() {
040        return "photonstruct:" + getTypeName() + ":" + getInterfaceUUID();
041    }
042
043    /** Gets the list of photonstruct types referenced by this struct. */
044    default PacketSerde<?>[] getNestedPhotonMessages() {
045        return new PacketSerde<?>[] {};
046    }
047
048    /** Gets the list of WPILib struct types referenced by this struct. */
049    default Struct<?>[] getNestedWpilibMessages() {
050        return new Struct<?>[] {};
051    }
052
053    /** The schema definition, as defined in photon-serde/README.md */
054    String getSchema();
055
056    /** The hash of the schema string */
057    String getInterfaceUUID();
058}