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>

Field Summary

Fields inherited from interface edu.wpi.first.util.struct.Struct

kSizeBool, kSizeDouble, kSizeFloat, kSizeInt16, kSizeInt32, kSizeInt64, kSizeInt8

Constructor Summary

Constructors

Constructor	Description
QuaternionStruct()

Method Summary

Modifier and Type	Method	Description
String	getSchema()	Gets the schema.
int	getSize()	Gets the serialized size (in bytes).
Class<Quaternion>	getTypeClass()	Gets the Class object for the stored value.
String	getTypeString()	Gets the type string (e.g.
void	pack(ByteBuffer bb, Quaternion value)	Puts object contents to a ByteBuffer starting at the current position.
Quaternion	unpack(ByteBuffer bb)	Deserializes an object from a raw struct serialized ByteBuffer starting at the current position.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.wpi.first.util.struct.Struct

getNested, unpackInto

Constructor Details

QuaternionStruct

public QuaternionStruct()

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

getTypeString

public String getTypeString()

Description copied from interface: Struct

Gets the type string (e.g. for NetworkTables). This should be globally unique and start with "struct:".

Specified by:

getTypeString in interface Struct<Quaternion>

Returns:

type string

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