org.jmisb.api.klv.st1908

Class Transmission

java.lang.Object

org.jmisb.api.klv.st1908.Transmission

All Implemented Interfaces:

IKlvValue, INestedKlvValue, IMimdMetadataValue

@Beta
public class Transmission
extends Object
implements IMimdMetadataValue, INestedKlvValue

Transmission Local Set. See ST1908 for more information on this data type.

Constructor Summary

Constructors

Constructor and Description
Transmission() Create a new empty Transmission local set.
Transmission(byte[] bytes) Construct Transmission Local Set from encoded bytes.
Transmission(byte[] data, int offset, int numBytes) Build a Transmission Local Set from encoded bytes.
Transmission(Map<TransmissionMetadataKey,IMimdMetadataValue> values) Create the Transmission local set from the given key/value pairs.

Method Summary

Modifier and Type	Method and Description
static Transmission	fromBytes(byte[] bytes) Create Transmission Local Set from encoded bytes.
byte[]	getBytes() Get the encoded bytes.
String	getDisplayableValue() Return a string of the displayable value.
String	getDisplayName() Get the human-readable name for the value.
Transmission_EndWavelength	getEndWavelength() Get the endWavelength attribute value.
IKlvValue	getField(IKlvKey tag) Get the value of a given item.
Set<? extends IKlvKey>	getIdentifiers() Get the set of identifiers for populated values.
MimdId	getMimdId() Get the mimdId attribute value.
NumericalPrecision	getNumericPrecision() Get the numericPrecision attribute value.
MimdIdReference	getSecurity() Get the security attribute value.
Transmission_StartWavelength	getStartWavelength() Get the startWavelength attribute value.
MimdIdReference	getTimer() Get the timer attribute value.
Base_TimerOffset	getTimerOffset() Get the timerOffset attribute value.
Transmission_Transmittance	getTransmittance() Get the transmittance attribute value.
void	setEndWavelength(Transmission_EndWavelength endWavelength) Set the endWavelength attribute value.
void	setMimdId(MimdId mimdId) Set the mimdId attribute value.
void	setNumericPrecision(NumericalPrecision numericPrecision) Set the numericPrecision attribute value.
void	setSecurity(MimdIdReference security) Set the security attribute value.
void	setStartWavelength(Transmission_StartWavelength startWavelength) Set the startWavelength attribute value.
void	setTimer(MimdIdReference timer) Set the timer attribute value.
void	setTimerOffset(Base_TimerOffset timerOffset) Set the timerOffset attribute value.
void	setTransmittance(Transmission_Transmittance transmittance) Set the transmittance attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transmission

public Transmission()

Create a new empty Transmission local set.

Transmission

public Transmission(Map<TransmissionMetadataKey,IMimdMetadataValue> values)

Create the Transmission local set from the given key/value pairs.

Parameters:

values - Tag/value pairs to be included in the local set

Transmission

public Transmission(byte[] data,
                    int offset,
                    int numBytes)
             throws KlvParseException

Build a Transmission Local Set from encoded bytes.

Parameters:

data - the bytes to build from.

offset - the offset into bytes to start parsing from.

numBytes - the number of bytes to parse.

Throws:

KlvParseException - if parsing fails (depending on InvalidDataHandler strategy)

Transmission

public Transmission(byte[] bytes)
             throws KlvParseException

Construct Transmission Local Set from encoded bytes.

Parameters:

bytes - Encoded byte array.

Throws:

KlvParseException - if the array could not be parsed

Method Detail

getMimdId

public MimdId getMimdId()

Get the mimdId attribute value.

Returns:

a MimdId value, or null if not set.

setMimdId

public void setMimdId(MimdId mimdId)

Set the mimdId attribute value.

Parameters:

mimdId - the MimdId value to set.

getTimer

public MimdIdReference getTimer()

Get the timer attribute value.

Returns:

a MimdIdReference value, or null if not set.

setTimer

public void setTimer(MimdIdReference timer)

Set the timer attribute value.

Parameters:

timer - the MimdIdReference value to set.

getTimerOffset

public Base_TimerOffset getTimerOffset()

Get the timerOffset attribute value.

Returns:

a org.jmisb.api.klv.st1904.Base_TimerOffset value, or null if not set.

setTimerOffset

public void setTimerOffset(Base_TimerOffset timerOffset)

Set the timerOffset attribute value.

Parameters:

timerOffset - the org.jmisb.api.klv.st1904.Base_TimerOffset value to set.

getNumericPrecision

public NumericalPrecision getNumericPrecision()

Get the numericPrecision attribute value.

Returns:

a org.jmisb.api.klv.st1904.NumericalPrecision value, or null if not set.

setNumericPrecision

public void setNumericPrecision(NumericalPrecision numericPrecision)

Set the numericPrecision attribute value.

Parameters:

numericPrecision - the NumericPrecision value to set.

getSecurity

public MimdIdReference getSecurity()

Get the security attribute value.

Returns:

a MimdIdReference value, or null if not set.

setSecurity

public void setSecurity(MimdIdReference security)

Set the security attribute value.

Parameters:

security - the MimdIdReference value to set.

getStartWavelength

public Transmission_StartWavelength getStartWavelength()

Get the startWavelength attribute value.

Returns:

a org.jmisb.api.klv.st1908.Transmission_StartWavelength value, or null if not set.

setStartWavelength

public void setStartWavelength(Transmission_StartWavelength startWavelength)

Set the startWavelength attribute value.

Parameters:

startWavelength - the org.jmisb.api.klv.st1908.Transmission_StartWavelength value to set.

getEndWavelength

public Transmission_EndWavelength getEndWavelength()

Get the endWavelength attribute value.

Returns:

a org.jmisb.api.klv.st1908.Transmission_EndWavelength value, or null if not set.

setEndWavelength

public void setEndWavelength(Transmission_EndWavelength endWavelength)

Set the endWavelength attribute value.

Parameters:

endWavelength - the org.jmisb.api.klv.st1908.Transmission_EndWavelength value to set.

getTransmittance

public Transmission_Transmittance getTransmittance()

Get the transmittance attribute value.

Returns:

a org.jmisb.api.klv.st1908.Transmission_Transmittance value, or null if not set.

setTransmittance

public void setTransmittance(Transmission_Transmittance transmittance)

Set the transmittance attribute value.

Parameters:

transmittance - the org.jmisb.api.klv.st1908.Transmission_Transmittance value to set.

fromBytes

public static Transmission fromBytes(byte[] bytes)
                              throws KlvParseException

Create Transmission Local Set from encoded bytes.

Parameters:

bytes - Encoded byte array

Returns:

new Transmission corresponding to the encoded byte array.

Throws:

KlvParseException - if the array could not be parsed

getBytes

public byte[] getBytes()

Description copied from interface: IMimdMetadataValue

Get the encoded bytes.

Specified by:

getBytes in interface IMimdMetadataValue

Returns:

The encoded byte array

getDisplayName

public String getDisplayName()

Description copied from interface: IKlvValue

Get the human-readable name for the value.

Specified by:

getDisplayName in interface IKlvValue

Returns:

The name of the type

getDisplayableValue

public String getDisplayableValue()

Description copied from interface: IKlvValue

Return a string of the displayable value.

Specified by:

getDisplayableValue in interface IKlvValue

Returns:

String representing the value

getField

public IKlvValue getField(IKlvKey tag)

Description copied from interface: INestedKlvValue

Get the value of a given item.

Specified by:

getField in interface INestedKlvValue

Parameters:

tag - Tag or other identifier of the value to retrieve

Returns:

The value, or null if no value was set

getIdentifiers

public Set<? extends IKlvKey> getIdentifiers()

Description copied from interface: INestedKlvValue

Get the set of identifiers for populated values.

Specified by:

getIdentifiers in interface INestedKlvValue

Returns:

The set of item identifiers for which values have been set