Module org.yamcs.core

Package org.yamcs.parameter

Class ParameterValue

java.lang.Object

org.yamcs.parameter.RawEngValue

org.yamcs.parameter.BasicParameterValue

org.yamcs.parameter.ParameterValue

Direct Known Subclasses:

ContainerParameterValue, PartialParameterValue

public class ParameterValue
extends BasicParameterValue

Field Summary

Fields inherited from class org.yamcs.parameter.RawEngValue

engValue, generationTime, rawValue

Constructor Summary

Constructors

Constructor	Description
ParameterValue(String fqn)
ParameterValue(ParameterValue pv)
ParameterValue(org.yamcs.xtce.Parameter def)	Creates a parameter value for a parameter

Method Summary

Modifier and Type	Method	Description
int	getAcqStatus()
long	getAcquisitionTime()
org.yamcs.xtce.Parameter	getParameter()	Retrieve the parameter definition for this parameter value
String	getParameterQualifiedName()
String	getParameterQualifiedNamed()	Deprecated. use getParameterQualifiedName()
boolean	hasAcquisitionTime()
boolean	isExpired(long now)	Verifies if the parameter value is expired at a given timestamp.
void	setAcquisitionTime(long instant)
void	setParameter(org.yamcs.xtce.Parameter p)
org.yamcs.protobuf.Pvalue.ParameterValue	toGpb()
org.yamcs.protobuf.Pvalue.ParameterValue	toGpb(int numericId)
org.yamcs.protobuf.Pvalue.ParameterValue	toGpb(org.yamcs.protobuf.Yamcs.NamedObjectId id)
org.yamcs.protobuf.Pvalue.ParameterValue	toProtobufParameterValue(Optional<org.yamcs.protobuf.Yamcs.NamedObjectId> id, OptionalInt numericId, boolean withExpiration)	Convert a PV to a ProtobufPV
String	toString()

Methods inherited from class org.yamcs.parameter.BasicParameterValue

addAlarmRanges, fromGpb, fromGpb, getAcquisitionStatus, getCriticalRange, getDeltaMonitoringResult, getDistressRange, getExpireMillis, getMonitoringResult, getRangeCondition, getSevereRange, getStatus, getWarningRange, getWatchRange, hasExpirationTime, isExpired, isInvalid, isNominal, isNotReceived, setAcqStatus, setCriticalRange, setDeltaMonitoringResult, setDistressRange, setEngValue, setExpired, setExpireMillis, setInvalid, setMonitoringResult, setNotReceived, setRangeCondition, setSevereRange, setStatus, setWarningRange, setWatchRange, toGpbAlarmRange

Methods inherited from class org.yamcs.parameter.RawEngValue

getEngValue, getGenerationTime, getRawValue, hasGenerationTime, setBinaryValue, setBooleanValue, setDoubleValue, setEngineeringValue, setFloatValue, setGenerationTime, setRawDoubleValue, setRawFloatValue, setRawSignedInteger, setRawSignedLong, setRawUnsignedInteger, setRawUnsignedLong, setRawValue, setRawValue, setRawValue, setRawValue, setSignedIntegerValue, setSignedLongValue, setStringValue, setUnsignedIntegerValue, setUnsignedLongValue

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterValue

public ParameterValue(org.yamcs.xtce.Parameter def)

Creates a parameter value for a parameter

Parameters:

def - the parameter definition

ParameterValue

public ParameterValue(String fqn)

ParameterValue

public ParameterValue(ParameterValue pv)

Method Details

setAcquisitionTime

public void setAcquisitionTime(long instant)

setParameter

public void setParameter(org.yamcs.xtce.Parameter p)

getParameter

public org.yamcs.xtce.Parameter getParameter()

Retrieve the parameter definition for this parameter value

Returns:

parameter definition

getParameterQualifiedName

public String getParameterQualifiedName()

getParameterQualifiedNamed

@Deprecated
public String getParameterQualifiedNamed()

Deprecated.

use getParameterQualifiedName()

Returns:

getAcquisitionTime

public long getAcquisitionTime()

toGpb

public org.yamcs.protobuf.Pvalue.ParameterValue toGpb()

toGpb

public org.yamcs.protobuf.Pvalue.ParameterValue toGpb(org.yamcs.protobuf.Yamcs.NamedObjectId id)

toGpb

public org.yamcs.protobuf.Pvalue.ParameterValue toGpb(int numericId)

toProtobufParameterValue

public org.yamcs.protobuf.Pvalue.ParameterValue toProtobufParameterValue(Optional<org.yamcs.protobuf.Yamcs.NamedObjectId> id,
 OptionalInt numericId,
 boolean withExpiration)

Convert a PV to a ProtobufPV

Parameters:

id - - the parameter identifier

Returns:

the created ProtobufPV

hasAcquisitionTime

public boolean hasAcquisitionTime()

isExpired

public boolean isExpired(long now)

Verifies if the parameter value is expired at a given timestamp. Returns false if the expireMillis is not set.

Parameters:

now -

Returns:

true if the parameter is expired at the timestamp now.

getAcqStatus

public int getAcqStatus()

toString

public String toString()

Overrides:

toString in class BasicParameterValue