rescuecore2.log

Interface LogReader

All Known Implementing Classes:

AbstractLogReader, FileLogReader, StreamLogReader

public interface LogReader

An interface for objects that know how to read log files.

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.

Method Detail

getConfig

Config getConfig()
          throws LogException

Get the configuration entry in the log file.

Returns:

The configuration stored in the log.

Throws:

LogException - If there is a problem reading the log.

getMaxTimestep

int getMaxTimestep()
            throws LogException

Get the last timestep recorded in this log.

Returns:

The last timestep number.

Throws:

LogException - If there is a problem reading the log.

getWorldModel

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

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

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

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

PerceptionRecord getPerception(int time,
                               EntityID entity)
                        throws LogException

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

CommandsRecord getCommands(int time)
                    throws LogException

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

UpdatesRecord getUpdates(int time)
                  throws LogException

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.