environmental

Class EnvironmentCustomer

java.lang.Object

environmental.EnvironmentCustomer

public class EnvironmentCustomer
extends Object

This class is used to retrieve environmental data. Its intent is to be used by the mission execution machines in the following way:

   EnviroCustomer envCustomer = new EnviroCustomer();
   envCustomer.addVariable(EnviroData.WATER_TEMP);
   envCustomer.addVariable(EnviroData.SALINITY);
   envCustomer.setUpdatePeriod(5*1000); // 5 secs.
   envCustomer.addListener(new EnviroAdapter()
   {
     // Override methods of interest
     public void updateWaterTemp(double value,double lat, double lon, double depth, Date time)
     {
       // Do something with value
     }
     public void updateSalinity(double value,double lat, double lon, double depth, Date time)
     {
        // Do something with value
     }

     // The following are typically called immediately before the update* methods.
     public double getLatitude()
     {
       return myCurrentLatitude;
     }
     public double getLongitude()
     {
       return myCurrentLongitude;
     }
     public double getDepth()
     {
       return myCurrentDepth();
     }
     public Date getTime()
     {
       return myCurrentTime;
     }
   });
   envCustomer.startUpdates();

   // At end of mission:
   envCustomer.stopUpdates();
   

This class retrieves data from the EnviroData instance, one of which (per physical machine) retrieves the data. It, in turn, is configured through the configuration/c_environ.xml file, which describes the data source(s).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentCustomer.EnviroAdapter Convenience class implementing EnviroListener.
static interface	EnvironmentCustomer.EnviroListener Definition of the interface for listeners to receive updates from this EnviroCustomer object.

Constructor Summary

Constructors

Constructor and Description
EnvironmentCustomer(boolean relativeTime)

Method Summary

Modifier and Type	Method and Description
void	addListener(EnvironmentCustomer.EnviroListener list) Add a listener for updates.
void	addVariable(int var) Add a variable to the list of variables which will be reported at the next scheduled update.
void	removeAllListeners()
void	setUpdatePeriod(long period) Set the period between variable updates.
void	setVariableList(Set<Integer> vars) Adds all variables in the set to the list of variables which will be reported at the next scheduled update.
void	startUpdates() Begin data updates at the previously set update period (default: 60 seconds)
void	stopUpdates() Stop updates.
void	unsetVariableList(Set<Integer> vars) Removes all variables in the set from the list of variables which will be reported at the next scheduled update.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentCustomer

public EnvironmentCustomer(boolean relativeTime)

Method Detail

startUpdates

public void startUpdates()

Begin data updates at the previously set update period (default: 60 seconds)

stopUpdates

public void stopUpdates()

Stop updates. To restart, do startUpdates().

setUpdatePeriod

public void setUpdatePeriod(long period)

Set the period between variable updates. At the end of each period, all interested variables are updated.

Parameters:

period - units = milliseconds

addVariable

public void addVariable(int var)

Add a variable to the list of variables which will be reported at the next scheduled update. The variables are from the static fields in EnviroData, such as EnviroData.WATER_TEMP.

Parameters:

var - int value from EnviroData

setVariableList

public void setVariableList(Set<Integer> vars)

Adds all variables in the set to the list of variables which will be reported at the next scheduled update. Each object in this list must be an Integer, with an int value as described in addVariable(int var).

Parameters:

vars - Set of Integers objects representing variable IDs in EnviroData

unsetVariableList

public void unsetVariableList(Set<Integer> vars)

Removes all variables in the set from the list of variables which will be reported at the next scheduled update. Each object in this list must be an Integer, with an int value as described above.

Parameters:

vars - Set of Integers objects representing variable IDs in EnviroData

addListener

public void addListener(EnvironmentCustomer.EnviroListener list)

Add a listener for updates. Based on the variables of interest (see setVariable(int var)), the methods in the listener object (which implements the EnviroListener interface) will be called at each update cycle.

Parameters:

list - object implementing the EnviroListener interface

removeAllListeners

public void removeAllListeners()