com.github.kayak.core.description

Class SignalDescription

java.lang.Object

com.github.kayak.core.description.SignalDescription

public class SignalDescription
extends java.lang.Object

A SignalDescription contains the parameters and methods to extract Signals from a Frame.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignalDescription.Type

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<SignalDescription>	nameComparator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignalDescription(MessageDescription description)
protected	SignalDescription(MultiplexDescription multiplexDescription, MessageDescription description, long multiplexCount)

Method Summary

Modifier and Type	Method and Description
void	addConsumer(Node consumer)
void	addLabel(Label l)
Signal	decodeData(byte[] data) Decode the binary data according to the signal information in this description. may return null if this is a multiplexed signal and the multiplex count does not match.
protected static long	extractBits(byte[] data, int offset, int length, java.nio.ByteOrder order) This function extracts a given number of bits out of a byte array starting at a given position.
java.util.Set<Label>	getAllLabels()
java.nio.ByteOrder	getByteOrder()
java.util.Set<Node>	getConsumers()
MessageDescription	getDescription()
double	getIntercept()
int	getLength()
MessageDescription	getMessageDescription()
long	getMultiplexCount()
MultiplexDescription	getMultiplexDescription()
java.lang.String	getName()
java.lang.String	getNotes()
int	getOffset()
java.lang.Object	getParent()
double	getSlope()
SignalDescription.Type	getType()
java.lang.String	getUnit()
boolean	isMultiplexed()
void	setByteOrder(java.nio.ByteOrder byteOrder)
void	setIntercept(double intercept)
void	setLength(int length)
void	setName(java.lang.String name)
void	setNotes(java.lang.String notes)
void	setOffset(int offset)
void	setSlope(double slope)
void	setType(SignalDescription.Type type)
void	setUnit(java.lang.String unit)

Methods inherited from class java.lang.Object

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

Field Detail

nameComparator

public static final java.util.Comparator<SignalDescription> nameComparator

Constructor Detail

SignalDescription

protected SignalDescription(MessageDescription description)

SignalDescription

protected SignalDescription(MultiplexDescription multiplexDescription,
                            MessageDescription description,
                            long multiplexCount)

Method Detail

addLabel

public void addLabel(Label l)

getAllLabels

public java.util.Set<Label> getAllLabels()

getDescription

public MessageDescription getDescription()

getMultiplexCount

public long getMultiplexCount()

getMessageDescription

public MessageDescription getMessageDescription()

getMultiplexDescription

public MultiplexDescription getMultiplexDescription()

isMultiplexed

public boolean isMultiplexed()

getParent

public java.lang.Object getParent()

getConsumers

public java.util.Set<Node> getConsumers()

addConsumer

public void addConsumer(Node consumer)

getByteOrder

public java.nio.ByteOrder getByteOrder()

setByteOrder

public void setByteOrder(java.nio.ByteOrder byteOrder)

getLength

public int getLength()

setLength

public void setLength(int length)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getOffset

public int getOffset()

setOffset

public void setOffset(int offset)

getType

public SignalDescription.Type getType()

setType

public void setType(SignalDescription.Type type)

getIntercept

public double getIntercept()

setIntercept

public void setIntercept(double intercept)

getNotes

public java.lang.String getNotes()

setNotes

public void setNotes(java.lang.String notes)

getSlope

public double getSlope()

setSlope

public void setSlope(double slope)

getUnit

public java.lang.String getUnit()

setUnit

public void setUnit(java.lang.String unit)

decodeData

public Signal decodeData(byte[] data)
                  throws DescriptionException

Decode the binary data according to the signal information in this description. may return null if this is a multiplexed signal and the multiplex count does not match.

Parameters:

data -

Returns:

Throws:

DescriptionException

extractBits

protected static long extractBits(byte[] data,
                                  int offset,
                                  int length,
                                  java.nio.ByteOrder order)
                           throws DescriptionException

This function extracts a given number of bits out of a byte array starting at a given position. The result is returned as a long. There are two issues with this approach. First we can not handle values that are wider than 2^63bit (because long is signed). This is possibly rarely used but nevertheless should be somehow fixed. Second the performance could be poor because calculation is done bitwise.

Parameters:

data - The byte array to work with

offset - The first bit to be extracted

length - The number of bits that have to be extracted

order - The ByteOrder for the extraction

Returns:

Long representation of the extracted bits

Throws:

DescriptionException