tit.summary.SuperSummarizer

tit.summary.SuperSummarizer Class Reference

Inheritance diagram for tit.summary.SuperSummarizer:

tit.observation.Observation List of all members.

Public Member Functions

 SuperSummarizer (FromUntilPair[] pairs, long defualtflytimeinit)
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
Summary[] getSummaries () throws SummariesNotFinishedException

Private Types

enum  Location {
  NOWHERE, FLY, TREE1, TREE2,
  TREE3, TREE4, TREE5, WALL1,
  WALL2, WALL3, WALL4, FLOOR,
  DOOR_OR_WINDOW, OTHER_LOCATION
}

Private Attributes

Location previouslocation
long previoustime
Location previousrestinglocation
Map< FromUntilPair, SummaryRecord > summaries
long defaultflytime

Detailed Description

Class for summarizing an observation.
Author:
Bart Sas

Member Enumeration Documentation

enum tit::summary::SuperSummarizer::Location [private]

The different locations where a bird can be.

Author:
Bart Sas
Enumerator:
NOWHERE  Nowhere.
FLY  Flying in the air.
TREE1  On tree 1.
TREE2  On tree 2.
TREE3  On tree 3.
TREE4  On tree 4.
TREE5  On tree 5.
WALL1  On wall 1.
WALL2  On wall 2.
WALL3  On wall 3.
WALL4  On wall 4.
FLOOR  On the floor.
DOOR_OR_WINDOW  On the door or the window.
OTHER_LOCATION  At an other location.

Constructor & Destructor Documentation

tit.summary.SuperSummarizer.SuperSummarizer ( FromUntilPair[]  pairs,
long  defualtflytimeinit 
)

Constructs a new Summarizer.

Parameters:
pairs The FromUntilPairs we are summarizing.
defualtflytimeinit The default fly time.

Member Function Documentation

void tit.summary.SuperSummarizer.startObservation (  )  throws ObservationInIllegalStateException

Starts this observation.

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

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

void tit.summary.SuperSummarizer.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 previoustime made observation.

Reimplemented from tit.observation.Observation.

Summary [] tit.summary.SuperSummarizer.getSummaries (  )  throws SummariesNotFinishedException

returns the summaries.

Returns:
The summaries.
Exceptions:
SummariesNotFinishedException Is thrown when the summaries are not finished.

Member Data Documentation

Location tit.summary.SuperSummarizer.previouslocation [private]

The bird's previous location (can't be NOWHERE).

long tit.summary.SuperSummarizer.previoustime [private]

The time of the previous recording.

Location tit.summary.SuperSummarizer.previousrestinglocation [private]

The bird's last (can't be FLY).

Map<FromUntilPair, SummaryRecord> tit.summary.SuperSummarizer.summaries [private]

A map of summaries.

long tit.summary.SuperSummarizer.defaultflytime [private]

The default fly time.

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