eu.baltrad.beast.rules.volume.VolumeRule Class Reference

Inheritance diagram for eu.baltrad.beast.rules.volume.VolumeRule:

Public Member Functions
int	getRuleId ()
void	setTimeout (int timeout)
int	getTimeout ()
int	getInterval ()
void	setInterval (int interval)
String	getType ()
boolean	isValid ()
void	setElevationMin (double e)
double	getElevationMin ()
	returns the min elevation angle in degrees
void	setElevationMax (double e)
double	getElevationMax ()
	returns the min elevation angle in degrees
void	setAscending (boolean ascending)
boolean	isAscending ()
void	setSources (List< String > sources)
List< String >	getSources ()
void	setDetectors (List< String > detectors)
List< String >	getDetectors ()
String	toStrFromDoubleList (List< Double > doubles)
synchronized IBltMessage	handle (IBltMessage message)
synchronized IBltMessage	timeout (long id, int why, Object data)
void	setRecipients (List< String > recipients)
void	afterPropertiesSet ()
String	getElevationAngles ()
void	setElevationAngles (String elevationAngles) throws IllegalArgumentException
void	setElevationAngles (List< Double > elevationAngles) throws IllegalArgumentException
List< Double >	getElevationAnglesAsDoubles ()
IFilter	getFilter ()
void	setFilter (IFilter filter)
MetadataMatcher	getMatcher ()
void	setMatcher (MetadataMatcher matcher)
boolean	isNominalTimeout ()
void	setNominalTimeout (boolean nominalTimeout)
boolean	isAdaptiveElevationAngles ()
void	setAdaptiveElevationAngles (boolean adaptiveElevationAngles)
int	getQualityControlMode ()
String	getQualityControlModeAsString ()
void	setQualityControlMode (int qualityControlMode)
void	setQualityControlMode (String qualityControlMode)

Static Public Attributes
static final String	TYPE = "blt_volume"
	The name of this static composite type.
static final int	QualityControlMode_ANALYZE_AND_APPLY = 0
	Performs the quality analysis and then applies the result to the original set.
static final int	QualityControlMode_ANALYZE = 1
	Only performs the quality analysis.
Static Public Attributes inherited from eu.baltrad.beast.rules.timer.ITimeoutRule
static final int	TIMEOUT = 0
	Timeout was triggered due to timeout.
static final int	CANCELLED = 1
	Timeout was triggered due to cancellation.

Protected Member Functions
	VolumeRule ()
	Default constructor, however use manager for creation.
void	setCatalog (Catalog catalog)
Catalog	getCatalog ()
void	setTimeoutManager (TimeoutManager mgr)
TimeoutManager	getTimeoutManager ()
void	setRuleUtilities (IRuleUtilities utilities)
IRuleUtilities	getRuleUtilities ()
void	setRuleId (int ruleid)
boolean	replaceScanElevation (List< CatalogEntry > entries, CatalogEntry entry, Time nominalTime)
	If entries contains a scan with same elevation angle as provided entry, then the entry in entries will be replaced with provided one if it is closer to the nominal time.
List< CatalogEntry >	filterEntries (List< CatalogEntry > entries, Time nominalTime)
	Removes all unwanted catalog entries.
List< CatalogEntry >	createCatalogEntryList ()
	Creates an array list for catalog entries.
boolean	areAdaptiveElevationAnglesMatching (List< CatalogEntry > entries, DateTime dt, String source)
	Checks if the adaptive elevation angles are matching or not.
boolean	areCriteriasMet (List< CatalogEntry > entries, DateTime dt, String source)
	Verifies if the criterias has been met so that we can create the message.
VolumeTimerData	createTimerData (IBltMessage message)
	If possible creates a CompositingTimerData.
IBltMessage	createMessage (DateTime nominalTime, List< CatalogEntry > entries)
	Creates a message if all nessecary entries are there.
DateTime	getNominalTime (Date d, Time t)
	Returns the nominal time for the specified time, i.e.
List< CatalogEntry >	fetchAllCurrentEntries (DateTime nominalTime, String source)
	Fetches the entries that are from the nominal time up until the stop time defined by the interval.
TimeIntervalFilter	createFilter (DateTime nominalTime, String source)
	Returns a filter used for inquirying what scans exists for the current time.

Detailed Description

Author

Anders Henja

Constructor & Destructor Documentation

VolumeRule()

eu.baltrad.beast.rules.volume.VolumeRule.VolumeRule ( )

inlineprotected

Default constructor, however use manager for creation.

Member Function Documentation

afterPropertiesSet()

void eu.baltrad.beast.rules.volume.VolumeRule.afterPropertiesSet ( )

inline

See also

org.springframework.beans.factory.InitializingBean.afterPropertiesSet()

areAdaptiveElevationAnglesMatching()

boolean eu.baltrad.beast.rules.volume.VolumeRule.areAdaptiveElevationAnglesMatching ( List< CatalogEntry > entries, DateTime dt, String source )

inlineprotected

Checks if the adaptive elevation angles are matching or not.

Parameters

entries	the entries with current elevation angles
dt	the nominal time (Currently Not Used)
source	the radar source

Returns

true if we have a matching situation, otherwise false

areCriteriasMet()

boolean eu.baltrad.beast.rules.volume.VolumeRule.areCriteriasMet ( List< CatalogEntry > entries, DateTime dt, String source )

inlineprotected

Verifies if the criterias has been met so that we can create the message.

Parameters

entries

a list of catalog entries

Returns

true if the criterias has been met.

createCatalogEntryList()

List< CatalogEntry > eu.baltrad.beast.rules.volume.VolumeRule.createCatalogEntryList ( )

inlineprotected

Creates an array list for catalog entries.

Returns

a list for catalog entries

createFilter()

TimeIntervalFilter eu.baltrad.beast.rules.volume.VolumeRule.createFilter ( DateTime nominalTime, String source )

inlineprotected

Returns a filter used for inquirying what scans exists for the current time.

Parameters

nominalTime	the nominal time
source	the source node id

Returns

the filter

createMessage()

IBltMessage eu.baltrad.beast.rules.volume.VolumeRule.createMessage ( DateTime nominalTime, List< CatalogEntry > entries )

inlineprotected

Creates a message if all nessecary entries are there.

Parameters

nominalTime	the nominal time
entries	the list of entries

Returns

a message if criterias are fullfilled, otherwise null

createTimerData()

VolumeTimerData eu.baltrad.beast.rules.volume.VolumeRule.createTimerData ( IBltMessage message )

inlineprotected

If possible creates a CompositingTimerData.

Parameters

message

the message (that should be a BltDataMessage)

Returns

a volume timer data or null if not possible

fetchAllCurrentEntries()

List< CatalogEntry > eu.baltrad.beast.rules.volume.VolumeRule.fetchAllCurrentEntries ( DateTime nominalTime, String source )

inlineprotected

Fetches the entries that are from the nominal time up until the stop time defined by the interval.

Parameters

nominalTime

the nominal time

Returns

a list of entries

filterEntries()

List< CatalogEntry > eu.baltrad.beast.rules.volume.VolumeRule.filterEntries ( List< CatalogEntry > entries, Time nominalTime )

inlineprotected

Removes all unwanted catalog entries.

Parameters

entries	the entries to be filtered
nominalTime	the expected nominal time

Returns

a list of filtered entries

getCatalog()

Catalog eu.baltrad.beast.rules.volume.VolumeRule.getCatalog ( )

inlineprotected

Returns

the catalog

getDetectors()

List< String > eu.baltrad.beast.rules.volume.VolumeRule.getDetectors ( )

inline

Returns

the detectors

getElevationMax()

double eu.baltrad.beast.rules.volume.VolumeRule.getElevationMax ( )

inline

returns the min elevation angle in degrees

Returns

the max elevation

getElevationMin()

double eu.baltrad.beast.rules.volume.VolumeRule.getElevationMin ( )

inline

returns the min elevation angle in degrees

Returns

the min elevation

getInterval()

int eu.baltrad.beast.rules.volume.VolumeRule.getInterval ( )

inline

Returns

the interval

getNominalTime()

DateTime eu.baltrad.beast.rules.volume.VolumeRule.getNominalTime ( Date d, Time t )

inlineprotected

Returns the nominal time for the specified time, i.e.

the start time period

Parameters

d	the date
t	the time

Returns

a nominal time

getRuleId()

int eu.baltrad.beast.rules.volume.VolumeRule.getRuleId ( )

inline

Returns

the ruleid

getRuleUtilities()

IRuleUtilities eu.baltrad.beast.rules.volume.VolumeRule.getRuleUtilities ( )

inlineprotected

Returns

the rule utilities

getSources()

List< String > eu.baltrad.beast.rules.volume.VolumeRule.getSources ( )

inline

Returns

the sources for which this rule applies.

getTimeout()

int eu.baltrad.beast.rules.volume.VolumeRule.getTimeout ( )

inline

Returns

the timeout

getTimeoutManager()

TimeoutManager eu.baltrad.beast.rules.volume.VolumeRule.getTimeoutManager ( )

inlineprotected

Returns

the timeout manager

getType()

String eu.baltrad.beast.rules.volume.VolumeRule.getType ( )

inline

See also

eu.baltrad.beast.rules.IRule.getType()

Implements eu.baltrad.beast.rules.IRule.

handle()

synchronized IBltMessage eu.baltrad.beast.rules.volume.VolumeRule.handle ( IBltMessage message )

inline

See also

eu.baltrad.beast.rules.IRule.handle(eu.baltrad.beast.message.IBltMessage)

Implements eu.baltrad.beast.rules.IRule.

isAdaptiveElevationAngles()

boolean eu.baltrad.beast.rules.volume.VolumeRule.isAdaptiveElevationAngles ( )

inline

Returns

the adaptiveElevationAngles

isAscending()

boolean eu.baltrad.beast.rules.volume.VolumeRule.isAscending ( )

inline

Returns

if the scans are performed in ascending order or not

isValid()

boolean eu.baltrad.beast.rules.volume.VolumeRule.isValid ( )

inline

See also

eu.baltrad.beast.rules.IRule.isValid()

Implements eu.baltrad.beast.rules.IRule.

replaceScanElevation()

boolean eu.baltrad.beast.rules.volume.VolumeRule.replaceScanElevation ( List< CatalogEntry > entries, CatalogEntry entry, Time nominalTime )

inlineprotected

If entries contains a scan with same elevation angle as provided entry, then the entry in entries will be replaced with provided one if it is closer to the nominal time.

Parameters

entries	a list of entries
entry	the entry that eventually should replace an existing one
nominalTime	the nominal time

Returns

if any entry is found with same elevation angle as provided one.

setAdaptiveElevationAngles()

void eu.baltrad.beast.rules.volume.VolumeRule.setAdaptiveElevationAngles ( boolean adaptiveElevationAngles )

inline

Parameters

adaptiveElevationAngles

the adaptiveElevationAngles to set

setAscending()

void eu.baltrad.beast.rules.volume.VolumeRule.setAscending ( boolean ascending )

inline

Parameters

ascending

sets if the scans are performed in ascending order or not, default = true

setCatalog()

void eu.baltrad.beast.rules.volume.VolumeRule.setCatalog ( Catalog catalog )

inlineprotected

Parameters

catalog

the catalog to set

setDetectors()

void eu.baltrad.beast.rules.volume.VolumeRule.setDetectors ( List< String > detectors )

inline

Parameters

detectors

the detectors to set

setElevationMax()

void eu.baltrad.beast.rules.volume.VolumeRule.setElevationMax ( double e )

inline

Parameters

e	the min elevation angle to set in degrees

setElevationMin()

void eu.baltrad.beast.rules.volume.VolumeRule.setElevationMin ( double e )

inline

Parameters

e	the min elevation angle to set in degrees

setInterval()

void eu.baltrad.beast.rules.volume.VolumeRule.setInterval ( int interval )

inline

Parameters

interval

the interval to set

setRecipients()

void eu.baltrad.beast.rules.volume.VolumeRule.setRecipients ( List< String > recipients )

inline

See also

eu.baltrad.beast.rules.IRuleRecipientAware.setRecipients(java.util.List)

Implements eu.baltrad.beast.rules.IRuleRecipientAware.

setRuleId()

void eu.baltrad.beast.rules.volume.VolumeRule.setRuleId ( int ruleid )

inlineprotected

Parameters

ruleid

the ruleid to set

setRuleUtilities()

void eu.baltrad.beast.rules.volume.VolumeRule.setRuleUtilities ( IRuleUtilities utilities )

inlineprotected

Parameters

utilities

the rule utilities

setSources()

void eu.baltrad.beast.rules.volume.VolumeRule.setSources ( List< String > sources )

inline

Parameters

sources

the sources for which this rule applies

setTimeout()

void eu.baltrad.beast.rules.volume.VolumeRule.setTimeout ( int timeout )

inline

Parameters

timeout

the timeout to set

setTimeoutManager()

void eu.baltrad.beast.rules.volume.VolumeRule.setTimeoutManager ( TimeoutManager mgr )

inlineprotected

Parameters

mgr	the timeout manager to set

timeout()

synchronized IBltMessage eu.baltrad.beast.rules.volume.VolumeRule.timeout ( long id, int why, Object data )

inline

See also

eu.baltrad.beast.rules.timer.ITimeoutRule.timeout(long, int, java.lang.Object)

Implements eu.baltrad.beast.rules.timer.ITimeoutRule.

Member Data Documentation

QualityControlMode_ANALYZE

final int eu.baltrad.beast.rules.volume.VolumeRule.QualityControlMode_ANALYZE = 1

static

Only performs the quality analysis.

QualityControlMode_ANALYZE_AND_APPLY

final int eu.baltrad.beast.rules.volume.VolumeRule.QualityControlMode_ANALYZE_AND_APPLY = 0

static

Performs the quality analysis and then applies the result to the original set.

TYPE

final String eu.baltrad.beast.rules.volume.VolumeRule.TYPE = "blt_volume"

static

The name of this static composite type.

---

The documentation for this class was generated from the following file:

• src/eu/baltrad/beast/rules/volume/VolumeRule.java