pt.lsts.imc.lsf

Class LsfIndex

java.lang.Object

pt.lsts.imc.lsf.LsfIndex

public class LsfIndex
extends java.lang.Object

This class processes a lsf log file and generates a respective index which can be used for a more efficient access to the messages in the log

Author:

zp, pdias

Constructor Summary

Constructors

Constructor and Description
LsfIndex(java.io.File lsfFile)
LsfIndex(java.io.File lsfFile, IMCDefinition defs) Class constructor.
LsfIndex(java.io.File lsfFile, IMCDefinition defs, LsfIndexListener listener)

Method Summary

Modifier and Type	Method and Description
int	advanceToTime(int startIndex, double timestamp)
void	cleanup() This must be called to break the mapping and free memory.
boolean	containsMessagesOfType(java.lang.String... messageTypes)
java.util.Collection<java.lang.Integer>	entitiesOfMessage(java.lang.String message) Retrieve all the entities generating the given message
java.lang.String	entityNameOf(int messageNumber)
int	entityOf(int messageNumber)
int	fieldIdOf(int messageNumber)
java.util.Collection<Announce>	getAvailableSystems()
IMCDefinition	getDefinitions() Retrieve the IMC definitions used by this LsfIndex object
double	getEndTime()
int	getEntityId(java.lang.String entityName) Look for an entity name in this log
java.lang.String	getEntityName(int entityId) This method uses the EntityInfo messages present in the log to calculate the name the of the given entity id. This method should be used only for single vehicle logs.
java.lang.String	getEntityName(int src, int src_ent) Retrieve the name of an entity for a specific vehicle. This method uses the EntityInfo messages in the log to calculate this value.
<T> T	getFirst(java.lang.Class<T> clazz)
int	getFirstMessageAtOrAfter(double timestamp)
int	getFirstMessageOfType(int type)
int	getFirstMessageOfType(java.lang.String abbrev)
<T> LsfIterator<T>	getIterator(java.lang.Class<T> msgType)
<T> LsfIterator<T>	getIterator(java.lang.Class<T> msgType, int fromIndex)
<T> LsfIterator<T>	getIterator(java.lang.Class<T> msgType, long millisBetweenMessages)
java.lang.Iterable<IMCMessage>	getIterator(java.lang.String msgType)
java.lang.Iterable<IMCMessage>	getIterator(java.lang.String msgType, int fromIndex)
java.lang.Iterable<IMCMessage>	getIterator(java.lang.String msgType, int fromIndex, long timestepMillis)
<T> T	getLast(java.lang.Class<T> clazz)
int	getLastMessageOfType(int type)
int	getLastMessageOfType(java.lang.String abbrev)
java.io.File	getLsfFile()
IMCMessage	getMessage(int messageNumber) Deserializes and retrieves the message at given index
<T> T	getMessage(int messageNumber, java.lang.Class<T> clazz)
IMCMessage	getMessageAt(java.lang.String type, double timestamp)
int	getMessageAtOrAfer(int type, int entity, int startIndex, double timestamp)
IMCMessage	getMessageAtOrAfter(java.lang.String type, int startIndex, double timestamp)
IMCMessage	getMessageAtOrAfter(java.lang.String type, int startIndex, int entity, double timestamp)
IMCMessage	getMessageAtOrAfter(java.lang.String type, java.lang.String entity, int startIndex, double timestamp)
byte[]	getMessageBytes(int ind) This method retrieves the bytes associated with the message at given index
int	getMsgIndexAt(java.lang.String type, double timestamp)
<T> T	getNext(double timestamp, java.lang.Class<T> clazz)
int	getNextMessageOfEntity(int type, int entity, int startIndex) This method returns the index of the next message with given type and source entity
int	getNextMessageOfEntity(java.lang.String entity, int startIndex) Retrieves the next message in the index that matches the given entity name
int	getNextMessageOfType(int type, int startIndex)
int	getNextMessageOfType(java.lang.String abbrev, int startIndex)
int	getNumberOfMessages()
int	getPreviousMessageOfType(int type, int startIndex)
double	getStartTime()
java.lang.String	getSystemName(int sysId)
java.util.Vector<Announce>	getSystemsOfType(Announce.SYS_TYPE type)
int	hashOf(int i) This method calculates an hashcode based on source and entity of the message at index i
boolean	hasMultipleVehicles()
boolean	isBigEndian(int messageNumber)
java.lang.Iterable<IMCMessage>	iterateEntityMessages(java.lang.String entityName) Get an iterator to traverse all messages in the log from a selected entity name
void	load(java.io.File lsfFile, IMCDefinition defs)
static void	main(java.lang.String[] args)
java.lang.Iterable<IMCMessage>	messagesOfType(int type)
java.lang.Iterable<IMCMessage>	messagesOfType(java.lang.String abbrev)
<T extends IMCMessage> T	nextMessageOfType(java.lang.Class<T> type, int startIndex)
long	positionOf(int messageNumber) Retrieve the offset in the lsf File for message at given index
int	sizeOf(int messageNumber)
java.lang.String	sourceNameOf(int messageNumber)
int	sourceOf(int messageNumber)
void	startReplay() Same as startReplay(1)
void	startReplay(long timeMultiplier, java.lang.String host, int port) Just for testing purposes.
double	timeOf(int messageNumber) Retrieve the time, in seconds since January 1st 1970 UTC of the given message
int	typeOf(int messageNumber) Retrieve the type of message at given index

Methods inherited from class java.lang.Object

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

Constructor Detail

LsfIndex

public LsfIndex(java.io.File lsfFile,
                IMCDefinition defs,
                LsfIndexListener listener)
         throws java.lang.Exception

Throws:

java.lang.Exception

LsfIndex

public LsfIndex(java.io.File lsfFile,
                IMCDefinition defs)
         throws java.lang.Exception

Class constructor. Creates a new index from given lsf File and IMC definitions.
This method will first look for an lsf.index file and load it. If none is found, the index is generated first.

Parameters:

lsfFile - The file, in lsf format with the messages log

defs - The IMC definitions for that log

Throws:

java.lang.Exception - If the log file is not valid / cannot be read.

LsfIndex

public LsfIndex(java.io.File lsfFile)
         throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

hashOf

public int hashOf(int i)

This method calculates an hashcode based on source and entity of the message at index i

Parameters:

i - The index of the message to calculate hashcode

Returns:

The calculated hashcode

advanceToTime

public int advanceToTime(int startIndex,
                         double timestamp)

load

public void load(java.io.File lsfFile,
                 IMCDefinition defs)
          throws java.lang.Exception

Throws:

java.lang.Exception

getMessageBytes

public byte[] getMessageBytes(int ind)

This method retrieves the bytes associated with the message at given index

Parameters:

ind - The index of the message

Returns:

The bytes, in the log file respective to the message

typeOf

public int typeOf(int messageNumber)

Retrieve the type of message at given index

Parameters:

messageNumber - The index of the message

Returns:

The IMC type (id) for the message at given index

timeOf

public double timeOf(int messageNumber)

Retrieve the time, in seconds since January 1st 1970 UTC of the given message

Parameters:

messageNumber - The index of the message in the log

Returns:

Time, in seconds since January 1st 1970 UTC of the given message

isBigEndian

public boolean isBigEndian(int messageNumber)

sourceNameOf

public java.lang.String sourceNameOf(int messageNumber)

entityNameOf

public java.lang.String entityNameOf(int messageNumber)

sizeOf

public int sizeOf(int messageNumber)

sourceOf

public int sourceOf(int messageNumber)

entityOf

public int entityOf(int messageNumber)

fieldIdOf

public int fieldIdOf(int messageNumber)

positionOf

public long positionOf(int messageNumber)

Retrieve the offset in the lsf File for message at given index

Parameters:

messageNumber - The index of the message

Returns:

The offset in the lsf File for message at given index

getMessage

public <T> T getMessage(int messageNumber,
                        java.lang.Class<T> clazz)
                 throws java.lang.Exception

Throws:

java.lang.Exception

iterateEntityMessages

public java.lang.Iterable<IMCMessage> iterateEntityMessages(java.lang.String entityName)

Get an iterator to traverse all messages in the log from a selected entity name

Parameters:

entityName - The entity to be iterated

Returns:

A message iterator that

getIterator

public java.lang.Iterable<IMCMessage> getIterator(java.lang.String msgType)

getIterator

public java.lang.Iterable<IMCMessage> getIterator(java.lang.String msgType,
                                                  int fromIndex)

getIterator

public java.lang.Iterable<IMCMessage> getIterator(java.lang.String msgType,
                                                  int fromIndex,
                                                  long timestepMillis)

getIterator

public <T> LsfIterator<T> getIterator(java.lang.Class<T> msgType)

getIterator

public <T> LsfIterator<T> getIterator(java.lang.Class<T> msgType,
                                      int fromIndex)

getIterator

public <T> LsfIterator<T> getIterator(java.lang.Class<T> msgType,
                                      long millisBetweenMessages)

getMessage

public IMCMessage getMessage(int messageNumber)

Deserializes and retrieves the message at given index

Parameters:

messageNumber - The message index

Returns:

The IMCMessage corresponding to the deserialization of the message at given index

getNumberOfMessages

public int getNumberOfMessages()

Returns:

Total number of messages in the log

startReplay

public void startReplay()

Same as startReplay(1)

startReplay

public void startReplay(long timeMultiplier,
                        java.lang.String host,
                        int port)

Just for testing purposes. This method will start broadcasting all messages in the log according to time separations.

Parameters:

timeMultiplier - If 1.0 is used, the separation between messages will be approximately the same as real-time. If this value is higher, the replay will be done faster in the same proportion.

getFirstMessageOfType

public int getFirstMessageOfType(java.lang.String abbrev)

getFirst

public <T> T getFirst(java.lang.Class<T> clazz)

getLast

public <T> T getLast(java.lang.Class<T> clazz)

getFirstMessageOfType

public int getFirstMessageOfType(int type)

getLastMessageOfType

public int getLastMessageOfType(java.lang.String abbrev)

getLastMessageOfType

public int getLastMessageOfType(int type)

getNextMessageOfType

public int getNextMessageOfType(int type,
                                int startIndex)

getNextMessageOfEntity

public int getNextMessageOfEntity(java.lang.String entity,
                                  int startIndex)

Retrieves the next message in the index that matches the given entity name

Parameters:

entity - The entity to look for

startIndex - Only messages after this index will be tested

Returns:

The first message, with index > startIndex that has a matching entity name.

getNextMessageOfEntity

public int getNextMessageOfEntity(int type,
                                  int entity,
                                  int startIndex)

This method returns the index of the next message with given type and source entity

Parameters:

type - The type of the message to look for

entity - The source entity (src_ent field in the header) to look for

startIndex - The index exactly before the index from where to start looking

Returns:

The index of the found message or -1 if no such message was found

entitiesOfMessage

public java.util.Collection<java.lang.Integer> entitiesOfMessage(java.lang.String message)

Retrieve all the entities generating the given message

Parameters:

message - The message

Returns:

A collection of entities that generated the given message in this log

getPreviousMessageOfType

public int getPreviousMessageOfType(int type,
                                    int startIndex)

getNextMessageOfType

public int getNextMessageOfType(java.lang.String abbrev,
                                int startIndex)

messagesOfType

public java.lang.Iterable<IMCMessage> messagesOfType(int type)

messagesOfType

public java.lang.Iterable<IMCMessage> messagesOfType(java.lang.String abbrev)

getDefinitions

public IMCDefinition getDefinitions()

Retrieve the IMC definitions used by this LsfIndex object

Returns:

the IMC definitions used by this LsfIndex object

hasMultipleVehicles

public boolean hasMultipleVehicles()

containsMessagesOfType

public boolean containsMessagesOfType(java.lang.String... messageTypes)

getEntityName

public java.lang.String getEntityName(int src,
                                      int src_ent)

Retrieve the name of an entity for a specific vehicle.
This method uses the EntityInfo messages in the log to calculate this value.

Parameters:

src - The IMC id of the system

src_ent - The id of the entity to be resolved

Returns:

The name of the entity with id src_ent in the the vehicle with id src.

getSystemName

public java.lang.String getSystemName(int sysId)

getEntityName

public java.lang.String getEntityName(int entityId)

This method uses the EntityInfo messages present in the log to calculate the name the of the given entity id.
This method should be used only for single vehicle logs. Otherwise #getEntityName(Integer, Integer) should be used instead.

Parameters:

entityId - The (numeric) id of the entity to resolve

Returns:

The resolved name of the entity

getEntityId

public int getEntityId(java.lang.String entityName)

Look for an entity name in this log

Parameters:

entityName - The name of the entity to look for

Returns:

The entity id or 255 if the entity was not found

cleanup

public void cleanup()

This must be called to break the mapping and free memory.

getAvailableSystems

public java.util.Collection<Announce> getAvailableSystems()

getNext

public <T> T getNext(double timestamp,
                     java.lang.Class<T> clazz)

getSystemsOfType

public java.util.Vector<Announce> getSystemsOfType(Announce.SYS_TYPE type)

getMessageAtOrAfer

public int getMessageAtOrAfer(int type,
                              int entity,
                              int startIndex,
                              double timestamp)

getStartTime

public double getStartTime()

getEndTime

public double getEndTime()

getMessageAtOrAfter

public IMCMessage getMessageAtOrAfter(java.lang.String type,
                                      java.lang.String entity,
                                      int startIndex,
                                      double timestamp)

getMsgIndexAt

public int getMsgIndexAt(java.lang.String type,
                         double timestamp)

getFirstMessageAtOrAfter

public int getFirstMessageAtOrAfter(double timestamp)

getMessageAt

public IMCMessage getMessageAt(java.lang.String type,
                               double timestamp)

nextMessageOfType

public <T extends IMCMessage> T nextMessageOfType(java.lang.Class<T> type,
                                                  int startIndex)

getMessageAtOrAfter

public IMCMessage getMessageAtOrAfter(java.lang.String type,
                                      int startIndex,
                                      double timestamp)

getMessageAtOrAfter

public IMCMessage getMessageAtOrAfter(java.lang.String type,
                                      int startIndex,
                                      int entity,
                                      double timestamp)

getLsfFile

public java.io.File getLsfFile()

Returns:

the lsfFile

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception