Package edu.wpi.grip.core.operations.network.networktables

Class NTPublishAnnotatedOperation<D,P extends Publishable>

java.lang.Object

edu.wpi.grip.core.operations.network.NetworkPublishOperation<D>

edu.wpi.grip.core.operations.network.PublishAnnotatedOperation<D,P>

edu.wpi.grip.core.operations.network.networktables.NTPublishAnnotatedOperation<D,P>

Type Parameters:

D - the type of the data to publish (e.g. Number)

P - the publishable analog of the data (e.g. .network.NumberPublishable NumberPublishable)

All Implemented Interfaces:

Operation

public class NTPublishAnnotatedOperation<D,P extends Publishable>
extends PublishAnnotatedOperation<D,P>

An operation that publishes any type that implements Publishable to NetworkTables. To be publishable, a type should have one or more accessor methods annotated with PublishValue. This is done with annotations instead of methods

Field Summary

Fields inherited from class edu.wpi.grip.core.operations.network.NetworkPublishOperation

dataSocket, dataType, nameSocket

Constructor Summary

Constructors

Constructor	Description
NTPublishAnnotatedOperation(InputSocket.Factory inputSocketFactory, java.lang.Class<D> dataType, java.lang.Class<P> publishType, java.util.function.Function<D,P> converter, MapNetworkPublisherFactory publisherFactory)	Creates an NTPublishAnnotatedOperation.
NTPublishAnnotatedOperation(InputSocket.Factory inputSocketFactory, java.lang.Class<P> dataType, MapNetworkPublisherFactory publisherFactory)	Creates an NTPublishAnnotatedOperation for a type that already implements Publishable (e.g.

Method Summary

Modifier and Type	Method	Description
static OperationDescription	descriptionFor(java.lang.Class<?> dataType)	Creates an OperationDescription for an NTPublishAnnotatedOperation that publishes data of the given type.

Methods inherited from class edu.wpi.grip.core.operations.network.PublishAnnotatedOperation

cleanUp, createFlagSockets, doPublish, get, getSocketType, valueMethodStream

Methods inherited from class edu.wpi.grip.core.operations.network.NetworkPublishOperation

getInputSockets, getOutputSockets, perform

Methods inherited from class java.lang.Object

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

Constructor Detail

NTPublishAnnotatedOperation

public NTPublishAnnotatedOperation(InputSocket.Factory inputSocketFactory,
                                   java.lang.Class<P> dataType,
                                   MapNetworkPublisherFactory publisherFactory)

Creates an NTPublishAnnotatedOperation for a type that already implements Publishable (e.g. ContoursReport).

Parameters:

inputSocketFactory - factory for creating the input sockets

dataType - the type of the data to publish

publisherFactory - factory for creating the publisher

NTPublishAnnotatedOperation

public NTPublishAnnotatedOperation(InputSocket.Factory inputSocketFactory,
                                   java.lang.Class<D> dataType,
                                   java.lang.Class<P> publishType,
                                   java.util.function.Function<D,P> converter,
                                   MapNetworkPublisherFactory publisherFactory)

Creates an NTPublishAnnotatedOperation.

Parameters:

inputSocketFactory - factory for creating the input sockets

dataType - the type of the data to publish

publishType - the publishable analog of the data type

converter - function for converting instances of the input type to publishable objects

publisherFactory - factory for creating the publisher

Method Detail

descriptionFor

public static OperationDescription descriptionFor(java.lang.Class<?> dataType)

Creates an OperationDescription for an NTPublishAnnotatedOperation that publishes data of the given type.

Parameters:

dataType - the type of the data to publish