PamguardMVC

Class PamObserverAdapter

java.lang.Object

PamguardMVC.PamObserverAdapter

All Implemented Interfaces:

PamObserver

public abstract class PamObserverAdapter
extends java.lang.Object
implements PamObserver

Adapter class for PamObserver so not necessary to implement absolutely everything.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor and Description
PamObserverAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
PamObserver	getObserverObject()
long	getRequiredDataHistory(PamObservable o, java.lang.Object arg)
void	masterClockUpdate(long milliSeconds, long sampleNumber)
void	noteNewSettings()
void	removeObservable(PamObservable o) called when an Observable (PamDataBlock) is removed from the system
void	setSampleRate(float sampleRate, boolean notify) New sample rate
void	update(PamObservable o, PamDataUnit arg) Informs the PamObserver that new data have been added to the Observable class

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamguardMVC.PamObserver

getObserverName

Constructor Detail

PamObserverAdapter

public PamObserverAdapter()

Method Detail

getObserverObject

public PamObserver getObserverObject()

Specified by:

getObserverObject in interface PamObserver

Returns:

the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.

getRequiredDataHistory

public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)

Specified by:

getRequiredDataHistory in interface PamObserver

Parameters:

o - PamObservable class requiring the data

arg - optional argument from PamObservable

Returns:

time in milliseconds requried by data held in PamObservable

masterClockUpdate

public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)

Specified by:

masterClockUpdate in interface PamObserver

noteNewSettings

public void noteNewSettings()

Specified by:

noteNewSettings in interface PamObserver

removeObservable

public void removeObservable(PamObservable o)

Description copied from interface: PamObserver

called when an Observable (PamDataBlock) is removed from the system

Specified by:

removeObservable in interface PamObserver

setSampleRate

public void setSampleRate(float sampleRate,
                 boolean notify)

Description copied from interface: PamObserver

New sample rate

Specified by:

setSampleRate in interface PamObserver

notify - Notify other PamObservers and PamObservables in the chain.

update

public void update(PamObservable o,
          PamDataUnit arg)

Description copied from interface: PamObserver

Informs the PamObserver that new data have been added to the Observable class

Specified by:

update in interface PamObserver

Parameters:

o - Reference to the Observable (a PamDataBlock)

arg - Reference to the new PamDataUnit