decodes.hdb.algo.HdbLookupTimeShiftRating Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendcs Show documentation
A collection of software for aggregatting and processing environmental data such as from NOAA GOES satellites.
The newest version!
package decodes.hdb.algo;

import java.util.Date;

import ilex.var.NamedVariableList;
import ilex.var.NamedVariable;
import decodes.tsdb.DbAlgorithmExecutive;
import decodes.tsdb.DbCompException;
import decodes.tsdb.DbIoException;
import decodes.tsdb.VarFlags;
// this new import was added by M. Bogner Aug 2012 for the 3.0 CP upgrade project
import decodes.tsdb.algo.AWAlgoType;
// this new import was added by M. Bogner March 2013 for the 5.3 CP upgrade project
// new class handles surrogate keys as an object
import decodes.sql.DbKey;

//AW:IMPORTS
import decodes.tsdb.RatingStatus;
import decodes.hdb.HDBRatingTable;
//AW:IMPORTS_END

//AW:JAVADOC
/**
Implements the Shift and Rating Table Lookups from the database.
Independent value is called "indep".
Dependent values are "shift" and "dep".
Shift may or may not be stored in the database

 */
//AW:JAVADOC_END
public class HdbLookupTimeShiftRating
	extends decodes.tsdb.algo.AW_AlgorithmBase
{
// Code modified September 2013 to include Reno Nevada customization logic
// Code modified by M. Bogner for inclusion into main source code tree
//AW:INPUTS
	public double indep;	//AW:TYPECODE=i
	String _inputNames[] = { "indep" };
//AW:INPUTS_END

//AW:LOCALVARS
	HDBRatingTable ShiftTable = null;
	HDBRatingTable RatingTable = null;
	private boolean firstCall = true;
//AW:LOCALVARS_END

//AW:OUTPUTS
	public NamedVariable dep = new NamedVariable("dep", 0);
	public NamedVariable shift = new NamedVariable("shift", 0);
	String _outputNames[] = { "dep", "shift" };
//AW:OUTPUTS_END

//AW:PROPERTIES
	public boolean variableShift = false;
	public double singleShift = 0;
	public String shiftTableType = "Time Interpolated Shift";
	String _propertyNames[] = { "variableShift", "singleShift" };
//AW:PROPERTIES_END

	// Allow javac to generate a no-args constructor.

	/**
	 * Algorithm-specific initialization provided by the subclass.
	 */
	protected void initAWAlgorithm( )
		throws DbCompException
	{
//AW:INIT
		_awAlgoType = AWAlgoType.TIME_SLICE;
//AW:INIT_END

//AW:USERINIT
//AW:USERINIT_END
	}
	
	/**
	 * This method is called once before iterating all time slices.
	 */
	protected void beforeTimeSlices()
		throws DbCompException
	{
//AW:BEFORE_TIMESLICES
		if (firstCall)
		{
			firstCall = false;
			// Find the name for the input parameter.
			// this int cast was added by M. Bogner Aug 2012 for the 3.0 CP upgrade project
			// this int cast with getvalue method was added by M. Bogner March 2013 for the 5.3 CP upgrade project
			// the surrogate keys were changed to a dbkey object
			DbKey indep_sdi = getSDI("indep");
			debug3("Constructing Shift and Rating tables for sdi " +
					indep_sdi);
			//default non extrapolation of lookups is fine here.
			ShiftTable = new HDBRatingTable(tsdb,shiftTableType,indep_sdi);
			RatingTable = new HDBRatingTable(tsdb,"Stage Flow",indep_sdi);
		}
		// This code will be executed once before each group of time slices.
		// For TimeSlice algorithms this is done once before all slices.
		//TODO: fix updates of rating table detection,
		//for now, just force tables to recheck the database for a new rating id
		// at every group of time slices
		ShiftTable.resetRatingId();
		RatingTable.resetRatingId();
//AW:BEFORE_TIMESLICES_END
	}

	/**
	 * Do the algorithm for a single time slice.
	 * AW will fill in user-supplied code here.
	 * Base class will set inputs prior to calling this method.
	 * User code should call one of the setOutput methods for a time-slice
	 * output variable.
	 *
	 * @throws DbCompException (or subclass thereof) if execution of this
	 *        algorithm is to be aborted.
	 */
	protected void doAWTimeSlice()
		throws DbCompException
	{
//AW:TIMESLICE
		if (isMissing(indep)) {
			deleteAllOutputs();
		}
                else if(indep <= 0.0D)
                // this mod by M. Bogner Sept 2013 was for Water Masters in Reno
                // seems they are the only ones using this alg and this code was in place
                // there for many years but source code did not reflect this cutomization
                {
                   double def_zero = 0.0D;
                   setOutput(shift, def_zero);
                   setOutput(dep, def_zero);
                }
		else {
			if (variableShift) {
				RatingStatus shiftRS = ShiftTable.doRating(indep,_timeSliceBaseTime);
				indep = indep + shiftRS.dep;
				shiftRS.dep = round(shiftRS.dep,2);
				debug3("Lookup Shift result:" +
						shiftRS.dep + " resulting indep: "+ indep);
				setOutput(shift, shiftRS.dep);
			} else
			{
				indep = indep + singleShift;
				setOutput(shift, singleShift);
			}
			RatingStatus rs = RatingTable.doRating(indep,_timeSliceBaseTime);
			rs.dep = round(rs.dep,2);
			setOutput(dep, rs.dep);
		}
//AW:TIMESLICE_END
	}

	/**
	 * This method is called once after iterating all time slices.
	 */
	protected void afterTimeSlices()
	{
//AW:AFTER_TIMESLICES
		// This code will be executed once after each group of time slices.
		// For TimeSlice algorithms this is done once after all slices.
//AW:AFTER_TIMESLICES_END
	}

	/**
	 * Required method returns a list of all input time series names.
	 */
	public String[] getInputNames()
	{
		return _inputNames;
	}

	/**
	 * Required method returns a list of all output time series names.
	 */
	public String[] getOutputNames()
	{
		return _outputNames;
	}

	/**
	 * Required method returns a list of properties that have meaning to
	 * this algorithm.
	 */
	public String[] getPropertyNames()
	{
		return _propertyNames;
	}
}