org.mbari.siam.utils
Class PuckUtils

java.lang.Object
  org.mbari.siam.utils.PuckUtils

public class PuckUtils
extends java.lang.Object

PuckUtils is a utility class that includes static constants and methods for writing and reading SIAM payloads from PUCKs.

Nested Class Summary

static class

PuckUtils.SiamPayloadParams SIAM payload parameters.

Field Summary

static java.lang.String

PUCK_REGISTRY_NAME This is the name of the file that defines correspondence between PUCK UUID and SIAM service

Constructor Summary

PuckUtils()

Method Summary

static boolean	hasSiamPayload(Puck puck) Return true if PUCK has payload.
static void	readSiamPayload(Puck puck, java.lang.String outputFileName) Read SIAM payload from PUCK on specified serial port and write to specified output file.
static PuckUtils.SiamPayloadParams	readSiamPayloadParams(Puck puck) Return SIAM payload parameters; return null if SIAM payload not found

Methods inherited from class java.lang.Object

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

Field Detail

PUCK_REGISTRY_NAME

public static final java.lang.String PUCK_REGISTRY_NAME

This is the name of the file that defines correspondence between PUCK UUID and SIAM service

Constructor Detail

PuckUtils

public PuckUtils()

Method Detail

readSiamPayload

public static void readSiamPayload(Puck puck,
                                   java.lang.String outputFileName)
                            throws java.io.IOException,
                                   java.lang.Exception

Read SIAM payload from PUCK on specified serial port and write to specified output file.

Throws:

java.io.IOException

java.lang.Exception

readSiamPayloadParams

public static PuckUtils.SiamPayloadParams readSiamPayloadParams(Puck puck)
                                                         throws java.io.IOException,
                                                                java.lang.Exception

Return SIAM payload parameters; return null if SIAM payload not found

Throws:

java.io.IOException

java.lang.Exception

hasSiamPayload

public static boolean hasSiamPayload(Puck puck)
                              throws java.io.IOException,
                                     java.lang.Exception

Return true if PUCK has payload.

Throws:

java.io.IOException

java.lang.Exception