PamguardMVC
Class Annotation

java.lang.Object
  PamguardMVC.Annotation

public class Annotation
extends java.lang.Object

Class for passing information around with Datablocks giving a record of what has happened to the data within them throughout the whole processing chain.

Since this has been added rather late into PAMGUARD, PamProcesses will automatically add this using the type from their owning PamControlledUnit and the process name.

Processes that need to add multiple annotations, such as the spectrogram noise reduction, will have to override default annotations.

Author:

Doug Gillespie

Field Summary

private java.lang.String	name Annotation name - defaults to the name of the PamProcess.
private java.lang.Object	owner Process that created the annotation.
private PamProcess	pamProcess PamProcess that created the annotation
private java.lang.String	type Annotation type - defaults to the type of the PamControlledUnit

Constructor Summary

Annotation(PamProcess pamProcess, java.lang.Object owner, java.lang.String type, java.lang.String name)

Method Summary

java.lang.String	getName()
java.lang.Object	getOwner()
PamProcess	getPamProcess()
java.lang.String	getType()
void	setName(java.lang.String name)
void	setOwner(java.lang.Object owner)
void	setPamProcess(PamProcess pamProcess)
void	setType(java.lang.String type)

Methods inherited from class java.lang.Object

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

Field Detail

type

private java.lang.String type

Annotation type - defaults to the type of the PamControlledUnit

name

private java.lang.String name

Annotation name - defaults to the name of the PamProcess.

owner

private java.lang.Object owner

Process that created the annotation. Generally, this will be the PamProcess, but may be a sub process.

pamProcess

private PamProcess pamProcess

PamProcess that created the annotation

Constructor Detail

Annotation

public Annotation(PamProcess pamProcess,
                  java.lang.Object owner,
                  java.lang.String type,
                  java.lang.String name)

Method Detail

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getOwner

public java.lang.Object getOwner()

setOwner

public void setOwner(java.lang.Object owner)

getPamProcess

public PamProcess getPamProcess()

setPamProcess

public void setPamProcess(PamProcess pamProcess)