org.yamcs.parameterarchive.ParameterId 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.parameterarchive;

import org.yamcs.protobuf.Yamcs.Value.Type;
import org.yamcs.utils.IntArray;

/**
 * 
 * The parameter archive gives each (fqn, rawType, engType) a numeric 32 bits pid.
 * 
 * fqn is the parameter fully qualified name
 * 
 * This interface is implemented by classes storing the association between fqn, pid, rawType and engType
 * 
 */
public interface ParameterId {

    public Type getRawType();

    public Type getEngType();

    public int getPid();

    public String getParamFqn();

    /**
     * @return true if the parameter id is not an aggregate or array
     */
    public boolean isSimple();

    /**
     * 
     * @return true if the parameter has a raw value. It is equivalent with getRawType()==null
     */
    public boolean hasRawValue();

    /**
     * Returns the ids of the components for aggregates or arrays. if isSimple() returns true, this method returns
     * null.
     */
    public IntArray getComponents();
}