tit.observation.Observation

tit.observation.Observation Class Reference

Inheritance diagram for tit.observation.Observation:

tit.observation.io.ObservationDOMWriter tit.observation.ReproducableObservation tit.summary.Summarizer tit.summary.SuperSummarizer tit.observation.ObservationRecord tit.observation.ObservationTableModel List of all members.

Public Member Functions

 Observation ()
boolean isUnstarted ()
boolean isStarted ()
boolean isStopped ()
void startObservation () throws ObservationInIllegalStateException
void stopObservation (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordFly (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordHop (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordPreen (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordBillwipe (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordBoink (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordPeckRing (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordTree1 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordTree2 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordTree3 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordTree4 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordTree5 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordWall1 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordWall2 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordWall3 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordWall4 (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordFloor (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordDoorOrWindow (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException
void recordOtherLocation (long time) throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Private Types

enum  State { UNSTARTED, STARTED, STOPPED }

Private Attributes

State state
long lastobservation

Detailed Description

Base class for all classes that can be used to record observations.
Author:
Bart Sas

Member Enumeration Documentation

enum tit::observation::Observation::State [private]

The states an observation can be in.

Enumerator:
UNSTARTED  Indicates that the observation hasn't been started yet.
STARTED  Indicates that the observation has started.
STOPPED  Indicates that the observation has stopped.

Constructor & Destructor Documentation

tit.observation.Observation.Observation (  ) 

Constructs a new unstarted observation.

Member Function Documentation

boolean tit.observation.Observation.isUnstarted (  ) 

Checks whether this observation is unstarted.

Returns:
true if this observation is unstarted, false otherwise.

boolean tit.observation.Observation.isStarted (  ) 

Checks whether this observation is started.

Returns:
true if this observation is started, false otherwise.

boolean tit.observation.Observation.isStopped (  ) 

Checks whether this observation is stopped.

Returns:
true if this observation is stoppped, false otherwise.

void tit.observation.Observation.startObservation (  )  throws ObservationInIllegalStateException

Starts this observation.

Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not unstarted.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.stopObservation ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Stops this observation.

Parameters:
time The time on which the observation is stopped.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordFly ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a fly.

Parameters:
time The time on which the fly is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordHop ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a hop.

Parameters:
time The time on which the hop is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordPreen ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a preen.

Parameters:
time The time on which the preen is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordBillwipe ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a billwipe.

Parameters:
time The time on which the billwipe is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordBoink ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a boink.

Parameters:
time The time on which the boink is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordPeckRing ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a peckring.

Parameters:
time The time on which the peckring is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordTree1 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a tree1.

Parameters:
time The time on which the tree1 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordTree2 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a tree2.

Parameters:
time The time on which the tree2 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordTree3 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a tree3.

Parameters:
time The time on which the tree3 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordTree4 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a tree4.

Parameters:
time The time on which the tree4 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordTree5 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a tree5.

Parameters:
time The time on which the tree5 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordWall1 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a wall1.

Parameters:
time The time on which the wall1 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordWall2 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a wall2.

Parameters:
time The time on which the wall2 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordWall3 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a wall3.

Parameters:
time The time on which the wall3 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordWall4 ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a wall4.

Parameters:
time The time on which the wall4 is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordFloor ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a floor.

Parameters:
time The time on which the floor is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordDoorOrWindow ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a doororwindow.

Parameters:
time The time on which the doororwindow is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

void tit.observation.Observation.recordOtherLocation ( long  time  )  throws ObservationInIllegalStateException, ObservationsInWrongOrderException

Records a otherlocation.

Parameters:
time The time on which the otherlocation is observed.
Exceptions:
ObservationInIllegalStateException Is thrown when the observation is not started.
ObservationsInWrongOrderException Is thrown when this observation's time comes before the time of a previous made observation.

Reimplemented in tit.observation.io.ObservationDOMWriter, tit.observation.ObservationRecord, tit.observation.ObservationTableModel, tit.summary.Summarizer, and tit.summary.SuperSummarizer.

Member Data Documentation

State tit.observation.Observation.state [private]

This observation's state.

long tit.observation.Observation.lastobservation [private]

Time on which the last observation was made.

The documentation for this class was generated from the following file:
Generated on Sun Jun 3 16:44:00 2007 by  doxygen 1.5.1