org.yamcs.parameter.SystemParametersProducer 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;

/**
 * Interface implemented by classes that want to provide system parameters.
 * These are collected regularly by the {@link SystemParametersService}
 * 
 * @author nm
 *
 */
public interface SystemParametersProducer {

    /**
     * return the next bunch of parameter values.
     * 
     * The gentime is the mission time when the parameter collection started. The returning parameters can use this time
     * to allow all parameters in one collection interval to be timestamped with the same time.
     */
    Collection getSystemParameters(long gentime);

    /**
     * How often this producer should be called. This is a multiplier for the base frequency which is 1 second.
     * 
     * For example a value of 3 means call each 3 seconds)
     * 
     * @return
     */
    default int getFrequency() {
        return 1;
    }

}