rescuecore2.log

Class FileLogReader

java.lang.Object

rescuecore2.log.AbstractLogReader

rescuecore2.log.FileLogReader

All Implemented Interfaces:

LogReader

public class FileLogReader
extends AbstractLogReader

A log reader that reads from a file.

Field Summary

Fields inherited from class rescuecore2.log.AbstractLogReader

registry

Constructor Summary

Constructors

Constructor and Description
FileLogReader(java.io.File file, Registry registry) Construct a new FileLogReader.
FileLogReader(java.lang.String name, Registry registry) Construct a new FileLogReader.

Method Summary

Modifier and Type	Method and Description
CommandsRecord	getCommands(int time) Get the agent commands at a particular timestep.
Config	getConfig() Get the configuration entry in the log file.
java.util.Set<EntityID>	getEntitiesWithUpdates(int time) Get the set of EntityIDs that have perception updates in a given timestep.
int	getMaxTimestep() Get the last timestep recorded in this log.
PerceptionRecord	getPerception(int time, EntityID entity) Get the perception record for a particular entity at a particular time.
UpdatesRecord	getUpdates(int time) Get the simulator updates at a particular timestep.
WorldModel<? extends Entity>	getWorldModel(int time) Get the state of the world at a particular timestep.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLogReader

public FileLogReader(java.lang.String name,
                     Registry registry)
              throws java.io.IOException,
                     LogException

Construct a new FileLogReader.

Parameters:

name - The name of the file to read.

registry - The registry to use for reading log entries.

Throws:

java.io.IOException - If the file cannot be read.

LogException - If there is a problem reading the log.

FileLogReader

public FileLogReader(java.io.File file,
                     Registry registry)
              throws java.io.IOException,
                     LogException

Construct a new FileLogReader.

Parameters:

file - The file object to read.

registry - The registry to use for reading log entries.

Throws:

java.io.IOException - If the file cannot be read.

LogException - If there is a problem reading the log.

Method Detail

getConfig

public Config getConfig()

Description copied from interface: LogReader

Get the configuration entry in the log file.

Returns:

The configuration stored in the log.

getMaxTimestep

public int getMaxTimestep()
                   throws LogException

Description copied from interface: LogReader

Get the last timestep recorded in this log.

Returns:

The last timestep number.

Throws:

LogException - If there is a problem reading the log.

getWorldModel

public WorldModel<? extends Entity> getWorldModel(int time)
                                           throws LogException

Description copied from interface: LogReader

Get the state of the world at a particular timestep.

Parameters:

time - The timestep to look up. If this is zero then the world initial conditions will be returned.

Returns:

The world model at the given timestep.

Throws:

LogException - If there is a problem reading the log.

getEntitiesWithUpdates

public java.util.Set<EntityID> getEntitiesWithUpdates(int time)
                                               throws LogException

Description copied from interface: LogReader

Get the set of EntityIDs that have perception updates in a given timestep.

Parameters:

time - The timestep to look up.

Returns:

The set of EntityIDs that have perception records for that time.

Throws:

LogException - If there is a problem reading the log.

getPerception

public PerceptionRecord getPerception(int time,
                                      EntityID entity)
                               throws LogException

Description copied from interface: LogReader

Get the perception record for a particular entity at a particular time.

Parameters:

time - The timestep to look up.

entity - The entity to look up.

Returns:

The perception record for the timestep/agent, or null if there is no such entry.

Throws:

LogException - If there is a problem reading the log.

getCommands

public CommandsRecord getCommands(int time)
                           throws LogException

Description copied from interface: LogReader

Get the agent commands at a particular timestep.

Parameters:

time - The timestep to look up.

Returns:

The commands record for the timestep, or null if there is no commands record at that timestep.

Throws:

LogException - If there is a problem reading the log.

getUpdates

public UpdatesRecord getUpdates(int time)
                         throws LogException

Description copied from interface: LogReader

Get the simulator updates at a particular timestep.

Parameters:

time - The timestep to look up.

Returns:

The updates record for the timestep, or null if there is no updates record at that timestep.

Throws:

LogException - If there is a problem reading the log.