ParameterValue (Yamcs Core 4.4.2 API)

java.lang.Object
- org.yamcs.parameter.ParameterValue

public class ParameterValue
extends Object

Holds the value of a parameter

Constructor Summary

Constructors
Constructor and Description
`ParameterValue(Parameter def)` Creates a parameter value for a parameter which has critical or warning range associated
`ParameterValue(ParameterValue pv)`
`ParameterValue(String fqn)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlarmRanges(List<Mdb.AlarmRange> alarmRangeList)`
`static ParameterValue`	`fromGpb(Parameter pdef, Pvalue.ParameterValue gpv)`
`static ParameterValue`	`fromGpb(String fqn, Pvalue.ParameterValue gpv)`
`int`	`getAbsoluteBitOffset()`
`Pvalue.AcquisitionStatus`	`getAcquisitionStatus()`
`long`	`getAcquisitionTime()`
`int`	`getBitSize()`
`DoubleRange`	`getCriticalRange()`
`Pvalue.MonitoringResult`	`getDeltaMonitoringResult()`
`DoubleRange`	`getDistressRange()`
`Value`	`getEngValue()`
`long`	`getExpireMills()`
`long`	`getGenerationTime()`
`Pvalue.MonitoringResult`	`getMonitoringResult()`
`Parameter`	`getParameter()` Retrieve the parameter definition for this parameter value
`ParameterEntry`	`getParameterEntry()`
`String`	`getParameterQualifiedNamed()`
`boolean`	`getProcessingStatus()`
`Pvalue.RangeCondition`	`getRangeCondition()`
`Value`	`getRawValue()`
`DoubleRange`	`getSevereRange()`
`ParameterStatus`	`getStatus()`
`DoubleRange`	`getWarningRange()`
`DoubleRange`	`getWatchRange()`
`boolean`	`hasAcquisitionTime()`
`boolean`	`hasExpirationTime()`
`boolean`	`isExpired(long now)` Verifies if the parameter value is expired at a given timestamp.
`void`	`setAbsoluteBitOffset(int absoluteBitOffset)`
`void`	`setAcquisitionStatus(Pvalue.AcquisitionStatus a)`
`void`	`setAcquisitionTime(long instant)`
`void`	`setBinaryValue(byte[] v)`
`void`	`setBitSize(int bitSize)`
`void`	`setBooleanValue(boolean b)`
`void`	`setCriticalRange(DoubleRange range)`
`void`	`setDeltaMonitoringResult(Pvalue.MonitoringResult m)`
`void`	`setDistressRange(DoubleRange range)`
`void`	`setDoubleValue(double v)`
`void`	`setEngineeringValue(Value ev)`
`void`	`setEngValue(Value engValue)`
`void`	`setExpireMillis(long em)`
`void`	`setFloatValue(float v)`
`void`	`setGenerationTime(long instant)`
`void`	`setMonitoringResult(Pvalue.MonitoringResult m)`
`void`	`setParameter(Parameter p)`
`void`	`setParameterEntry(ParameterEntry entry)`
`void`	`setProcessingStatus(boolean p)`
`void`	`setRangeCondition(Pvalue.RangeCondition rangeCondition)`
`void`	`setRawDoubleValue(double d)`
`void`	`setRawFloatValue(float f)`
`void`	`setRawSignedInteger(int x)`
`void`	`setRawSignedLong(long x)`
`void`	`setRawUnsignedInteger(int x)`
`void`	`setRawUnsignedLong(long x)`
`void`	`setRawValue(boolean b)`
`void`	`setRawValue(byte[] b)`
`void`	`setRawValue(String s)`
`void`	`setRawValue(Value rv)`
`void`	`setSevereRange(DoubleRange range)`
`void`	`setSignedIntegerValue(int v)`
`void`	`setSignedLongValue(long v)`
`void`	`setStatus(ParameterStatus parameterStatus)`
`void`	`setStringValue(String s)`
`void`	`setUnsignedIntegerValue(int v)`
`void`	`setUnsignedLongValue(long v)`
`void`	`setWarningRange(DoubleRange range)`
`void`	`setWatchRange(DoubleRange range)`
`Pvalue.ParameterValue`	`toGpb(Yamcs.NamedObjectId id)`
`static Mdb.AlarmRange`	`toGpbAlarmRange(Mdb.AlarmLevelType gpbLevel, DoubleRange floatRange)`
`Pvalue.ParameterValue`	`toProtobufParameterValue(Optional<Yamcs.NamedObjectId> id, boolean withUtc)` Convert a PV to a ProtobufPV
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- ParameterValue
```
public ParameterValue(Parameter def)
```
  Creates a parameter value for a parameter which has critical or warning range associated
  
  Parameters:
  
  def - the parameter definition
- ParameterValue
```
public ParameterValue(String fqn)
```
- ParameterValue
```
public ParameterValue(ParameterValue pv)
```

Method Detail

getAbsoluteBitOffset
```
public int getAbsoluteBitOffset()
```

setAbsoluteBitOffset

public void setAbsoluteBitOffset(int absoluteBitOffset)

getBitSize
```
public int getBitSize()
```

setBitSize
```
public void setBitSize(int bitSize)
```

setParameterEntry

public void setParameterEntry(ParameterEntry entry)

getParameterEntry

public ParameterEntry getParameterEntry()

setAcquisitionTime

public void setAcquisitionTime(long instant)

setGenerationTime

public void setGenerationTime(long instant)

getEngValue
```
public Value getEngValue()
```

getRawValue
```
public Value getRawValue()
```

setParameter

public void setParameter(Parameter p)

getParameter
```
public Parameter getParameter()
```
Retrieve the parameter definition for this parameter value

Returns:

parameter definition

getParameterQualifiedNamed

public String getParameterQualifiedNamed()

getGenerationTime
```
public long getGenerationTime()
```

getAcquisitionTime
```
public long getAcquisitionTime()
```

setRawValue
```
public void setRawValue(Value rv)
```

setRawValue
```
public void setRawValue(byte[] b)
```

setRawFloatValue

public void setRawFloatValue(float f)

setRawDoubleValue

public void setRawDoubleValue(double d)

setRawValue
```
public void setRawValue(boolean b)
```

setRawValue
```
public void setRawValue(String s)
```

setRawSignedInteger

public void setRawSignedInteger(int x)

setRawUnsignedInteger

public void setRawUnsignedInteger(int x)

setRawSignedLong
```
public void setRawSignedLong(long x)
```

setRawUnsignedLong

public void setRawUnsignedLong(long x)

setStringValue
```
public void setStringValue(String s)
```

setBinaryValue
```
public void setBinaryValue(byte[] v)
```

setBooleanValue

public void setBooleanValue(boolean b)

setDoubleValue
```
public void setDoubleValue(double v)
```

setFloatValue
```
public void setFloatValue(float v)
```

setSignedIntegerValue

public void setSignedIntegerValue(int v)

setUnsignedIntegerValue

public void setUnsignedIntegerValue(int v)

setSignedLongValue

public void setSignedLongValue(long v)

setUnsignedLongValue

public void setUnsignedLongValue(long v)

setEngineeringValue

public void setEngineeringValue(Value ev)

setExpireMillis
```
public void setExpireMillis(long em)
```

getExpireMills
```
public long getExpireMills()
```

setEngValue

public void setEngValue(Value engValue)

setWatchRange

public void setWatchRange(DoubleRange range)

setWarningRange

public void setWarningRange(DoubleRange range)

setDistressRange

public void setDistressRange(DoubleRange range)

setCriticalRange

public void setCriticalRange(DoubleRange range)

setSevereRange

public void setSevereRange(DoubleRange range)

setMonitoringResult

public void setMonitoringResult(Pvalue.MonitoringResult m)

setDeltaMonitoringResult

public void setDeltaMonitoringResult(Pvalue.MonitoringResult m)

setRangeCondition

public void setRangeCondition(Pvalue.RangeCondition rangeCondition)

setProcessingStatus

public void setProcessingStatus(boolean p)

setAcquisitionStatus

public void setAcquisitionStatus(Pvalue.AcquisitionStatus a)

getDistressRange
```
public DoubleRange getDistressRange()
```

getWatchRange
```
public DoubleRange getWatchRange()
```

getCriticalRange
```
public DoubleRange getCriticalRange()
```

getWarningRange
```
public DoubleRange getWarningRange()
```

getSevereRange
```
public DoubleRange getSevereRange()
```

getMonitoringResult

public Pvalue.MonitoringResult getMonitoringResult()

getRangeCondition

public Pvalue.RangeCondition getRangeCondition()

getAcquisitionStatus

public Pvalue.AcquisitionStatus getAcquisitionStatus()

getProcessingStatus
```
public boolean getProcessingStatus()
```

getDeltaMonitoringResult

public Pvalue.MonitoringResult getDeltaMonitoringResult()

getStatus
```
public ParameterStatus getStatus()
```

setStatus

public void setStatus(ParameterStatus parameterStatus)

toProtobufParameterValue
```
public Pvalue.ParameterValue toProtobufParameterValue(Optional<Yamcs.NamedObjectId> id,
                                                      boolean withUtc)
```
Convert a PV to a ProtobufPV

Parameters:

id - - the parameter identifier

withUtc - - if true - set the UTC string times

Returns:

the created ProtobufPV

toGpb

public Pvalue.ParameterValue toGpb(Yamcs.NamedObjectId id)

toGpbAlarmRange

public static Mdb.AlarmRange toGpbAlarmRange(Mdb.AlarmLevelType gpbLevel,
                                             DoubleRange floatRange)

fromGpb

public static ParameterValue fromGpb(String fqn,
                                     Pvalue.ParameterValue gpv)

fromGpb

public static ParameterValue fromGpb(Parameter pdef,
                                     Pvalue.ParameterValue gpv)

addAlarmRanges

public void addAlarmRanges(List<Mdb.AlarmRange> alarmRangeList)

hasAcquisitionTime
```
public boolean hasAcquisitionTime()
```

hasExpirationTime
```
public boolean hasExpirationTime()
```

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.

toString
```
public String toString()
```
Overrides:

toString in class Object

Class ParameterValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParameterValue

ParameterValue

ParameterValue

Method Detail

getAbsoluteBitOffset

setAbsoluteBitOffset

getBitSize

setBitSize

setParameterEntry

getParameterEntry

setAcquisitionTime

setGenerationTime

getEngValue

getRawValue

setParameter

getParameter

getParameterQualifiedNamed

getGenerationTime

getAcquisitionTime

setRawValue

setRawValue

setRawFloatValue

setRawDoubleValue

setRawValue

setRawValue

setRawSignedInteger

setRawUnsignedInteger

setRawSignedLong

setRawUnsignedLong

setStringValue

setBinaryValue

setBooleanValue

setDoubleValue

setFloatValue

setSignedIntegerValue

setUnsignedIntegerValue

setSignedLongValue

setUnsignedLongValue

setEngineeringValue

setExpireMillis

getExpireMills

setEngValue

setWatchRange

setWarningRange

setDistressRange

setCriticalRange

setSevereRange

setMonitoringResult

setDeltaMonitoringResult

setRangeCondition

setProcessingStatus

setAcquisitionStatus

getDistressRange

getWatchRange

getCriticalRange

getWarningRange

getSevereRange

getMonitoringResult

getRangeCondition

getAcquisitionStatus

getProcessingStatus

getDeltaMonitoringResult

getStatus

setStatus

toProtobufParameterValue

toGpb

toGpbAlarmRange

fromGpb

fromGpb

addAlarmRanges

hasAcquisitionTime

hasExpirationTime

isExpired

toString