org.mbari.siam.distributed
Class MetadataPacket

java.lang.Object
  org.mbari.siam.distributed.DevicePacket
      org.mbari.siam.distributed.MetadataPacket

All Implemented Interfaces:

java.io.Serializable

public class MetadataPacket
extends DevicePacket
implements java.io.Serializable

MetadataPacket contains information relating to "state" of the generating device.

Author:

Tom O'Reilly

See Also:

Serialized Form

Field Summary

static int	AUTO_GENERATED Indicates that packet was generated autonomously (i.e.
static java.lang.String	DEVICE_INFO_CLOSE_TAG
static java.lang.String	DEVICE_INFO_TAG Tags delimiting device status in payload.
static java.lang.String	INSTRUMENT_DOC_CLOSE_TAG
static java.lang.String	INSTRUMENT_DOC_TAG Tags delimiting instrument document in payload.
static java.lang.String	SERVICE_ATTR_CLOSE_TAG
static java.lang.String	SERVICE_ATTR_TAG Tags delimiting service attributes in payload.
static java.lang.String	SERVICE_PROP_CLOSE_TAG
static java.lang.String	SERVICE_PROP_TAG Tags delimiting service properties document in payload.

Fields inherited from class org.mbari.siam.distributed.DevicePacket

ALL_TYPES, DEVICEMESSAGE_FLAG, HEADER_BYTES, METADATA_FLAG, SENSORDATA_FLAG, SUMMARY_FLAG

Constructor Summary

MetadataPacket()

MetadataPacket(long sourceID, byte[] cause, byte[] bytes)

Method Summary

byte[]	cause() Indication of what generated the MetadataPacket
byte[]	getBytes() Get status bytes.
java.lang.String	toString() Return String representation.

Methods inherited from class org.mbari.siam.distributed.DevicePacket

convertToAscii, getParentId, getRecordType, isPrintable, metadataRef, sequenceNo, setMetadataRef, setParentId, setRecordType, setSequenceNo, setSystemTime, sourceID, systemTime

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_ATTR_TAG

public static final java.lang.String SERVICE_ATTR_TAG

Tags delimiting service attributes in payload.

See Also:

Constant Field Values

SERVICE_ATTR_CLOSE_TAG

public static final java.lang.String SERVICE_ATTR_CLOSE_TAG

See Also:

Constant Field Values

DEVICE_INFO_TAG

public static final java.lang.String DEVICE_INFO_TAG

Tags delimiting device status in payload.

See Also:

Constant Field Values

DEVICE_INFO_CLOSE_TAG

public static final java.lang.String DEVICE_INFO_CLOSE_TAG

See Also:

Constant Field Values

INSTRUMENT_DOC_TAG

public static final java.lang.String INSTRUMENT_DOC_TAG

Tags delimiting instrument document in payload.

See Also:

Constant Field Values

INSTRUMENT_DOC_CLOSE_TAG

public static final java.lang.String INSTRUMENT_DOC_CLOSE_TAG

See Also:

Constant Field Values

SERVICE_PROP_TAG

public static final java.lang.String SERVICE_PROP_TAG

Tags delimiting service properties document in payload.

See Also:

Constant Field Values

SERVICE_PROP_CLOSE_TAG

public static final java.lang.String SERVICE_PROP_CLOSE_TAG

See Also:

Constant Field Values

AUTO_GENERATED

public static final int AUTO_GENERATED

Indicates that packet was generated autonomously (i.e. not from any external command.

See Also:

Constant Field Values

Constructor Detail

MetadataPacket

public MetadataPacket()

MetadataPacket

public MetadataPacket(long sourceID,
                      byte[] cause,
                      byte[] bytes)

Parameters:

sourceID - unique identifier of source device

cause - reason packet was generated

bytes - data buffer

Method Detail

cause

public byte[] cause()

Indication of what generated the MetadataPacket

getBytes

public byte[] getBytes()

Get status bytes.

toString

public java.lang.String toString()

Return String representation.

Overrides:

toString in class DevicePacket