ParameterValue (Yamcs Core 3.1.2 API)

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

public class ParameterValue
extends Object

Holds the value of a parameter

Author:: mache

Constructor Summary

Constructors
Constructor and Description
`ParameterValue(Parameter def)` Creates a parameter value for a parameter which has critical or warning range associated
`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)`
`int`	`getAbsoluteBitOffset()`
`Pvalue.AcquisitionStatus`	`getAcquisitionStatus()`
`long`	`getAcquisitionTime()`
`int`	`getBitSize()`
`FloatRange`	`getCriticalRange()`
`Pvalue.MonitoringResult`	`getDeltaMonitoringResult()`
`FloatRange`	`getDistressRange()`
`Value`	`getEngValue()`
`long`	`getExpirationTime()`
`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()`
`FloatRange`	`getSevereRange()`
`FloatRange`	`getWarningRange()`
`FloatRange`	`getWatchRange()`
`boolean`	`hasAcquisitionTime()`
`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(FloatRange range)`
`void`	`setDeltaMonitoringResult(Pvalue.MonitoringResult m)`
`void`	`setDistressRange(FloatRange range)`
`void`	`setDoubleValue(double v)`
`void`	`setEngineeringValue(Value ev)`
`void`	`setEngValue(Value engValue)`
`void`	`setExpirationTime(long et)`
`void`	`setFloatValue(float v)`
`void`	`setGenerationTime(long instant)`
`void`	`setMonitoringResult(Pvalue.MonitoringResult m)`
`void`	`setParameterEntry(ParameterEntry entry)`
`void`	`setProcessingStatus(boolean p)`
`void`	`setRangeCondition(Pvalue.RangeCondition rangeCondition)`
`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(double d)`
`void`	`setRawValue(float f)`
`void`	`setRawValue(String s)`
`void`	`setRawValue(Value rv)`
`void`	`setSevereRange(FloatRange range)`
`void`	`setSignedIntegerValue(int v)`
`void`	`setSignedLongValue(long v)`
`void`	`setStringValue(String s)`
`void`	`setUnsignedIntegerValue(int v)`
`void`	`setUnsignedLongValue(long v)`
`void`	`setWarningRange(FloatRange range)`
`void`	`setWatchRange(FloatRange range)`
`Pvalue.ParameterValue`	`toGpb(Yamcs.NamedObjectId id)`
`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)
```

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()
```

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)
```

setRawValue
```
public void setRawValue(float f)
```

setRawValue
```
public void setRawValue(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)

setExpirationTime

public void setExpirationTime(long et)

getExpirationTime
```
public long getExpirationTime()
```

setEngValue

public void setEngValue(Value engValue)

setWatchRange

public void setWatchRange(FloatRange range)

setWarningRange

public void setWarningRange(FloatRange range)

setDistressRange

public void setDistressRange(FloatRange range)

setCriticalRange

public void setCriticalRange(FloatRange range)

setSevereRange

public void setSevereRange(FloatRange 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 FloatRange getDistressRange()
```

getWatchRange
```
public FloatRange getWatchRange()
```

getCriticalRange
```
public FloatRange getCriticalRange()
```

getWarningRange
```
public FloatRange getWarningRange()
```

getSevereRange
```
public FloatRange 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()

toGpb

public Pvalue.ParameterValue toGpb(Yamcs.NamedObjectId id)

fromGpb

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

addAlarmRanges

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

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

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

Method Detail

getAbsoluteBitOffset

setAbsoluteBitOffset

getBitSize

setBitSize

setParameterEntry

getParameterEntry

setAcquisitionTime

setGenerationTime

getEngValue

getRawValue

getParameter

getParameterQualifiedNamed

getGenerationTime

getAcquisitionTime

setRawValue

setRawValue

setRawValue

setRawValue

setRawValue

setRawValue

setRawSignedInteger

setRawUnsignedInteger

setRawSignedLong

setRawUnsignedLong

setStringValue

setBinaryValue

setBooleanValue

setDoubleValue

setFloatValue

setSignedIntegerValue

setUnsignedIntegerValue

setSignedLongValue

setUnsignedLongValue

setEngineeringValue

setExpirationTime

getExpirationTime

setEngValue

setWatchRange

setWarningRange

setDistressRange

setCriticalRange

setSevereRange

setMonitoringResult

setDeltaMonitoringResult

setRangeCondition

setProcessingStatus

setAcquisitionStatus

getDistressRange

getWatchRange

getCriticalRange

getWarningRange

getSevereRange

getMonitoringResult

getRangeCondition

getAcquisitionStatus

getProcessingStatus

getDeltaMonitoringResult

toGpb

fromGpb

addAlarmRanges

hasAcquisitionTime

toString