org.epics.pvaClient.PvaClientMonitorData Maven / Gradle / Ivy
/**
* Copyright - See the COPYRIGHT that is included with this distribution.
* EPICS pvData is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
*/
package org.epics.pvaClient;
import org.epics.pvdata.factory.ConvertFactory;
import org.epics.pvdata.misc.BitSet;
import org.epics.pvdata.monitor.MonitorElement;
import org.epics.pvdata.property.Alarm;
import org.epics.pvdata.property.PVAlarm;
import org.epics.pvdata.property.PVAlarmFactory;
import org.epics.pvdata.property.PVTimeStamp;
import org.epics.pvdata.property.PVTimeStampFactory;
import org.epics.pvdata.property.TimeStamp;
import org.epics.pvdata.property.TimeStampFactory;
import org.epics.pvdata.pv.Convert;
import org.epics.pvdata.pv.DoubleArrayData;
import org.epics.pvdata.pv.PVArray;
import org.epics.pvdata.pv.PVDouble;
import org.epics.pvdata.pv.PVDoubleArray;
import org.epics.pvdata.pv.PVField;
import org.epics.pvdata.pv.PVScalar;
import org.epics.pvdata.pv.PVScalarArray;
import org.epics.pvdata.pv.PVStringArray;
import org.epics.pvdata.pv.PVStructure;
import org.epics.pvdata.pv.ScalarType;
import org.epics.pvdata.pv.StringArrayData;
import org.epics.pvdata.pv.Structure;
import org.epics.pvdata.pv.Type;
/**
* This is a convenience wrapper for data for a channel monitor.
* @author mrk
* @since 2015.06
*/
public class PvaClientMonitorData {
/**
* Create an instance of PvaClientMonitorData.
* @param structure The introspection interface for the data.
* @return The new instance.
*/
static PvaClientMonitorData create(Structure structure) {
return new PvaClientMonitorData(structure);
}
private PvaClientMonitorData(Structure structure)
{
this.structure = structure;
}
private static final Convert convert = ConvertFactory.getConvert();
private static final String noStructure ="no pvStructure ";
private static final String noValue = "no value field";
private static final String noScalar = "value is not a scalar" ;
private static final String notCompatibleScalar = "value is not a compatible scalar" ;
private static final String notArray = "value is not an array" ;
private static final String notScalarArray = "value is not a scalarArray" ;
private static final String notDoubleArray = "value is not a doubleArray" ;
private static final String notStringArray = "value is not a stringArray" ;
private static final String noAlarm = "no alarm" ;
private static final String noTimeStamp = "no timeStamp" ;
private final Structure structure;
private PVStructure pvStructure = null;
private BitSet changedBitSet = null;
private BitSet overrunBitSet = null;
private String messagePrefix = "";
private PVField pvValue = null;
private final PVAlarm pvAlarm = PVAlarmFactory.create();
private final Alarm alarm = new Alarm();
private final PVTimeStamp pvTimeStamp = PVTimeStampFactory.create();
private final TimeStamp timeStamp = TimeStampFactory.create();
private final DoubleArrayData doubleArrayData = new DoubleArrayData();
private final StringArrayData stringArrayData = new StringArrayData();
/**
* This is called by pvaClientMonitor when it gets a monitor.
* @param monitorElement The new data.
*/
void setData(MonitorElement monitorElement)
{
pvStructure = monitorElement.getPVStructure();
changedBitSet = monitorElement.getChangedBitSet();
overrunBitSet = monitorElement.getOverrunBitSet();
pvValue = pvStructure.getSubField("value");
}
private void checkValue()
{
if(pvValue!=null) return;
throw new RuntimeException(messagePrefix + noValue);
}
/**
* Set a prefix for throw messages.
* @param value The prefix.
*/
public void setMessagePrefix(String value)
{
messagePrefix = value + " ";
}
/** Get the structure.
* @return the structure.
*/
public Structure getStructure()
{
return structure;
}
/** Get the pvStructure.
* @return the pvStructure.
*/
public PVStructure getPVStructure()
{
if(pvStructure!=null) return pvStructure;
throw new RuntimeException(messagePrefix + noStructure);
}
/** Get the changed BitSet for the pvStructure
* This shows which fields have changed value.
* @return The bitSet
*/
public BitSet getChangedBitSet()
{
if(changedBitSet!=null) return changedBitSet;
throw new RuntimeException(messagePrefix + noStructure);
}
/** Get the overrun BitSet for the pvStructure
* This shows which fields have had more than one change
* @return The changedBitSet
*/
public BitSet getOverrunBitSet()
{
if(overrunBitSet!=null) return overrunBitSet;
throw new RuntimeException(messagePrefix + noStructure);
}
/**
* Show fields that have changed value, i. e. all fields as shown by changedBitSet.
* @return The changed fields.
*/
public String showChanged()
{
if(changedBitSet==null) throw new RuntimeException(messagePrefix + noStructure);
String result = "";
PVField pvField;
int nextSet = changedBitSet.nextSetBit(0);
while(nextSet>=0) {
if(nextSet==0) {
pvField = pvStructure;
} else {
pvField = pvStructure.getSubField(nextSet);
}
result += pvField.getFullName() + " = " + pvField + "\n";
nextSet = changedBitSet.nextSetBit(nextSet + 1);
}
return result;
}
/**
* Show fields that have overrun value, i. e. all fields as shown by overrun bitSet.
* @return The overrun fields.
*/
public String showOverrun()
{
if(overrunBitSet==null) throw new RuntimeException(messagePrefix + noStructure);
String result = "";
PVField pvField;
int nextSet = overrunBitSet.nextSetBit(0);
while(nextSet>=0) {
if(nextSet==0) {
pvField = pvStructure;
} else {
pvField = pvStructure.getSubField(nextSet);
}
result += pvField.getFullName() + " = " + pvField + "\n";
nextSet = overrunBitSet.nextSetBit(nextSet + 1);
}
return result;
}
/**
* Is there a top level field named value of the PVstructure returned by channelGet?
* @return The answer.
*/
public boolean hasValue()
{
if(pvValue==null) return false;
return true;
}
/**
* Is the value field a scalar?
* @return The answer.
*/
public boolean isValueScalar()
{
if(pvValue==null) return false;
if(pvValue.getField().getType()==Type.scalar) return true;
return false;
}
/**
* Is the value field a scalar array?
* @return The answer.
*/
public boolean isValueScalarArray()
{
if(pvValue==null) return false;
if(pvValue.getField().getType()==Type.scalarArray) return true;
return false;
}
/**
* Return the interface to the value field.
* @return The interface or null if no top level value field.
*/
public PVField getValue()
{
checkValue();
return pvValue;
}
/**
* Return the interface to a scalar value field.
* @return Return the interface for a scalar value field or null if no scalar value field.
*/
public PVScalar getScalarValue()
{
checkValue();
PVScalar pv = pvStructure.getSubField(PVScalar.class,"value");
if(pv==null) throw new RuntimeException(messagePrefix + noScalar);
return pv;
}
/**
* Return the interface to an array value field.
* @return Return the interface or null if an array value field does not exist.
*/
public PVArray getArrayValue()
{
checkValue();
PVArray pv = pvStructure.getSubField(PVArray.class,"value");
if(pv==null) throw new RuntimeException(messagePrefix + notArray);
return pv;
}
/**
* Return the interface to a scalar array value field.
* @return Return the interface or null if a scalar array value field does not exist
*/
public PVScalarArray getScalarArrayValue()
{
checkValue();
PVScalarArray pv = pvStructure.getSubField(PVScalarArray.class,"value");
if(pv==null) throw new RuntimeException(messagePrefix + notScalarArray);
return pv;
}
/**
* Get the value as a double.
* @return If value is not a numeric scalar setStatus is called and 0 is returned.
*/
public double getDouble()
{
PVScalar pvScalar = getScalarValue();
ScalarType scalarType = pvScalar.getScalar().getScalarType();
if(scalarType==ScalarType.pvDouble) {
PVDouble pv = (PVDouble)pvScalar;
return pv.get();
}
if(!scalarType.isNumeric()) throw new RuntimeException(
messagePrefix + notCompatibleScalar);
return convert.toDouble(pvScalar);
}
/**
* Get the value as a string.
* @return If value is not a scalar setStatus is called and 0 is returned.
*/
public String getString()
{
PVScalar pvScalar = getScalarValue();
return convert.toString(pvScalar);
}
/**
* Get the value as a double array.
* @return If the value is not a numeric array null is returned.
*/
public double[] getDoubleArray()
{
checkValue();
PVDoubleArray pvDoubleArray = pvStructure.getSubField(
PVDoubleArray.class,"value");
if(pvDoubleArray==null) throw new RuntimeException(
messagePrefix + notDoubleArray);
int length = pvDoubleArray.getLength();
double[] data = new double[length];
pvDoubleArray.get(0, length, doubleArrayData);
for(int i=0; i© 2015 - 2025 Weber Informatics LLC | Privacy Policy