org.ka2ddo.opentrac

Class OpenTracPathTrace

java.lang.Object

org.ka2ddo.opentrac.OpenTracElement

org.ka2ddo.opentrac.OpenTracPathTrace

All Implemented Interfaces:

java.io.Serializable

public class OpenTracPathTrace
extends OpenTracElement

This class represents the trace of all the stations this OpenTracEntity was relayed through. It is not yet specified in the protocol whether this applies to all entities in a multiple-entity OpenTracMessage or only to the entity in which it is embedded.

Author:

Andrew Pavlin, KA2DDO

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
TraceStep[]	steps Array of the relay stations through which this entity has been forwarded (may be zero-length if received from the originating station).

Fields inherited from class org.ka2ddo.opentrac.OpenTracElement

id

Constructor Summary

Constructors

Constructor and Description
OpenTracPathTrace() Create no-step OpenTracPathTrace element.
OpenTracPathTrace(int type, byte[] body, int offset, int length) Create an OpenTRAC element with a short value from the next series of bytes in an encoded OpenTRAC message.

Method Summary

Modifier and Type	Method and Description
int	computeBody(byte[] buf, int offset) Append this element to a message buffer
boolean	equalsElement(OpenTracElement other) Test if this OpenTracElement has the same type and value as another OpenTracElement.
int	length() Return the number of bytes needed to encode this element.
java.lang.String	valueString() Get the string representation of the value of this element.

Methods inherited from class org.ka2ddo.opentrac.OpenTracElement

getId, toString

Methods inherited from class java.lang.Object

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

Field Detail

steps

public TraceStep[] steps

Array of the relay stations through which this entity has been forwarded (may be zero-length if received from the originating station).

Constructor Detail

OpenTracPathTrace

public OpenTracPathTrace()

Create no-step OpenTracPathTrace element.

OpenTracPathTrace

public OpenTracPathTrace(int type,
                         byte[] body,
                         int offset,
                         int length)

Create an OpenTRAC element with a short value from the next series of bytes in an encoded OpenTRAC message.

Parameters:

type - OpenTRAC element type code

body - byte array containing the encoded OpenTRAC elements

offset - starting index in the array where this element begins

length - remaining number of bytes in the OpenTRAC encoded message

Method Detail

computeBody

public int computeBody(byte[] buf,
                       int offset)

Append this element to a message buffer

Specified by:

computeBody in class OpenTracElement

Parameters:

buf - byte array to add the element to

offset - starting index to store the element

Returns:

index after the end of the stored element

valueString

public java.lang.String valueString()

Get the string representation of the value of this element.

Specified by:

valueString in class OpenTracElement

Returns:

value string

length

public int length()

Return the number of bytes needed to encode this element.

Specified by:

length in class OpenTracElement

Returns:

byte count needed to hold this element

equalsElement

public boolean equalsElement(OpenTracElement other)

Test if this OpenTracElement has the same type and value as another OpenTracElement.

Specified by:

equalsElement in class OpenTracElement

Parameters:

other - OpenTracElement to compare against this element

Returns:

boolean true if elements are of the same type, class, and value