org.yamcs.xtce

Class SequenceEntry

java.lang.Object

org.yamcs.xtce.SequenceEntry

All Implemented Interfaces:

Serializable, Comparable<SequenceEntry>

Direct Known Subclasses:

ArgumentEntry, ContainerEntry, FixedValueEntry, ParameterEntry

public abstract class SequenceEntry
extends Object
implements Serializable, Comparable<SequenceEntry>

An abstract type used by sequence containers. An entry contains a location in the container. The location may be either fixed or dynamic, absolute (to the start or end of the enclosing container, or relative (to either the previous or subsequent entry). Entries may also repeat.

Author:

nm

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SequenceEntry.ReferenceLocationType The location may be relative to the start of the container (containerStart), or relative to the end of the previous entry (previousEntry)

Field Summary

Fields

Modifier and Type	Field and Description
protected Container	container
protected int	locationInContainerInBits if the referenceLocation is containerStart, then this is number of bits from the start for previousEntry, this is the number of bits from where the previous entry ends

Constructor Summary

Constructors

Constructor and Description
SequenceEntry()
SequenceEntry(int position, Container container, int locationInContainerInBits, SequenceEntry.ReferenceLocationType location)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SequenceEntry se)
Container	getContainer()
int	getIndex()
int	getLocationInContainerInBits()
SequenceEntry.ReferenceLocationType	getReferenceLocation()
Repeat	getRepeatEntry()
SequenceContainer	getSequenceContainer()
void	setContainer(Container container)
void	setIndex(int index)
void	setLocationInContainerInBits(int locationInBits)
void	setReferenceLocation(SequenceEntry.ReferenceLocationType type)
void	setRepeatEntry(Repeat repeat)

Methods inherited from class java.lang.Object

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

Field Detail

container

protected Container container

locationInContainerInBits

protected int locationInContainerInBits

if the referenceLocation is containerStart, then this is number of bits from the start for previousEntry, this is the number of bits from where the previous entry ends

Constructor Detail

SequenceEntry

public SequenceEntry()

SequenceEntry

public SequenceEntry(int position,
                     Container container,
                     int locationInContainerInBits,
                     SequenceEntry.ReferenceLocationType location)

Method Detail

setContainer

public void setContainer(Container container)

setIndex

public void setIndex(int index)

getContainer

public Container getContainer()

getSequenceContainer

public SequenceContainer getSequenceContainer()

setLocationInContainerInBits

public void setLocationInContainerInBits(int locationInBits)

getLocationInContainerInBits

public int getLocationInContainerInBits()

setReferenceLocation

public void setReferenceLocation(SequenceEntry.ReferenceLocationType type)

compareTo

public int compareTo(SequenceEntry se)

Specified by:

compareTo in interface Comparable<SequenceEntry>

Parameters:

se -

Returns:

the difference in indexes

getReferenceLocation

public SequenceEntry.ReferenceLocationType getReferenceLocation()

getIndex

public int getIndex()

getRepeatEntry

public Repeat getRepeatEntry()

setRepeatEntry

public void setRepeatEntry(Repeat repeat)