Package edu.wpi.first.math.geometry.struct

Class QuaternionStruct

java.lang.Object
edu.wpi.first.math.geometry.struct.QuaternionStruct
All Implemented Interfaces:
Struct<Quaternion>
public class QuaternionStruct extends Object implements Struct<Quaternion>

  • Constructor Details

  • Method Details

    • getTypeClass

      public Class<Quaternion> getTypeClass()
      Description copied from interface: Struct
      Gets the Class object for the stored value.
      Specified by:
      getTypeClass in interface Struct<Quaternion>
      Returns:
      Class

    • getTypeName

      public String getTypeName()
      Description copied from interface: Struct
      Gets the type name (e.g. for schemas of other structs). This should be globally unique among structs.
      Specified by:
      getTypeName in interface Struct<Quaternion>
      Returns:
      type name

    • getSize

      public int getSize()
      Description copied from interface: Struct
      Gets the serialized size (in bytes). This should always be a constant.
      Specified by:
      getSize in interface Struct<Quaternion>
      Returns:
      serialized size

    • getSchema

      public String getSchema()
      Description copied from interface: Struct
      Gets the schema.
      Specified by:
      getSchema in interface Struct<Quaternion>
      Returns:
      schema

    • unpack

      public Quaternion unpack(ByteBuffer bb)
      Description copied from interface: Struct
      Deserializes an object from a raw struct serialized ByteBuffer starting at the current position. Will increment the ByteBuffer position by getStructSize() bytes. Will not otherwise modify the ByteBuffer (e.g. byte order will not be changed).
      Specified by:
      unpack in interface Struct<Quaternion>
      Parameters:
      bb - ByteBuffer
      Returns:
      New object

    • pack

      public void pack(ByteBuffer bb, Quaternion value)
      Description copied from interface: Struct
      Puts object contents to a ByteBuffer starting at the current position. Will increment the ByteBuffer position by getStructSize() bytes. Will not otherwise modify the ByteBuffer (e.g. byte order will not be changed).
      Specified by:
      pack in interface Struct<Quaternion>
      Parameters:
      bb - ByteBuffer
      value - object to serialize

    • isImmutable

      public boolean isImmutable()
      Description copied from interface: Struct
      Returns whether or not objects are immutable. Immutable objects must also be comparable using the equals() method. Default implementation returns false.
      Specified by:
      isImmutable in interface Struct<Quaternion>
      Returns:
      True if object is immutable