org.yamcs.parameter.ParameterCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-core Show documentation

There is a newer version: 5.10.9

package org.yamcs.parameter;

import java.util.Collection;
import java.util.List;

import org.yamcs.xtce.Parameter;

public interface ParameterCache {

    /**
     * update the parameters in the cache
    
     * @param pvs - parameter value list
     */
    void update(Collection pvs);

    /**
     * Returns cached value for parameter or an empty list if there is no value in the cache
     * 
     * 
     * @param plist
     * @return
     */
    List getValues(List plist);

    /**
     * Returns last cached value for parameter or null if there is no value in the cache
     * @param p - parameter for which the last value is returned
     * @return
     */
    ParameterValue getLastValue(Parameter p);

    /**
     * Returns all values from the cache for the parameter or null if there is no value cached
     * 
     * The parameter are returned in descending order (newest parameter is returned first)
     * @param p - parameter for which all values are returned
     * @return all values from the cache for the parameter or null if there is no value cached
     */
    List getAllValues(Parameter p);

    /**
     * Same as above but return all values that have the generation time in the (start, stop] interval
     * @param p
     * @param start
     * @param stop
     * @return
     */
    List getAllValues(Parameter p, long start, long stop);

    /**
     * Remove all the parameters from the cache
     */
    void clear();

}