org.epics.pvmanager.pva

Class PVATypeAdapter

java.lang.Object

org.epics.pvmanager.pva.PVATypeAdapter

All Implemented Interfaces:

DataSourceTypeAdapter<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

public abstract class PVATypeAdapter
extends Object
implements DataSourceTypeAdapter<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Type adapter for PVA data source. Will match a channel based on the value type provided and the array flag. Will match the cache based on the type class.

Author:

msekoranja

Constructor Summary

Constructors

Constructor and Description
PVATypeAdapter(Class<?> typeClass, String[] ntIds) Creates a new type adapter.
PVATypeAdapter(Class<?> typeClass, String[] ntIds, org.epics.pvdata.pv.Field fieldType) Creates a new type adapter.
PVATypeAdapter(Class<?> typeClass, String[] ntIds, org.epics.pvdata.pv.Field[] fieldTypes) Creates a new type adapter.

Method Summary

Methods

Modifier and Type	Method and Description
abstract Object	createValue(org.epics.pvdata.pv.PVStructure message, org.epics.pvdata.pv.PVField valueField, boolean disconnected) Given the value create the new value.
Object	getSubscriptionParameter(ValueCache<?> cache, PVAChannelHandler channel) The parameters required to open a monitor for the channel.
boolean	match(org.epics.pvdata.pv.Structure structure)
int	match(ValueCache<?> cache, PVAChannelHandler channel) Determines whether the converter can take values from the channel described by the connection payload and transform them in a type required by the cache.
String	toString()
boolean	updateCache(ValueCache cache, PVAChannelHandler channel, org.epics.pvdata.pv.PVStructure message) Takes the information in the message and updates the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

PVATypeAdapter

public PVATypeAdapter(Class<?> typeClass,
              String[] ntIds)

Creates a new type adapter.

Parameters:

typeClass - the java type this adapter will create

ntIds - array of IDs this adapter is able convert, null allowed

PVATypeAdapter

public PVATypeAdapter(Class<?> typeClass,
              String[] ntIds,
              org.epics.pvdata.pv.Field fieldType)

Creates a new type adapter.

Parameters:

typeClass - the java type this adapter will create

ntIds - array of IDs this adapter is able convert, null allowed

fieldType - Field instance this adapter is able convert

PVATypeAdapter

public PVATypeAdapter(Class<?> typeClass,
              String[] ntIds,
              org.epics.pvdata.pv.Field[] fieldTypes)

Creates a new type adapter.

Parameters:

typeClass - the java type this adapter will create

ntIds - array of IDs this adapter is able convert, null allowed

fieldTypes - Field instances this adapter is able convert, null allowed

Method Detail

match

public boolean match(org.epics.pvdata.pv.Structure structure)

match

public int match(ValueCache<?> cache,
        PVAChannelHandler channel)

Description copied from interface: DataSourceTypeAdapter

Determines whether the converter can take values from the channel described by the connection payload and transform them in a type required by the cache.

Specified by:

match in interface DataSourceTypeAdapter<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

cache - the cache where data will need to be written

channel - the connection information

Returns:

zero if there is no match, or the position of the type matched

getSubscriptionParameter

public Object getSubscriptionParameter(ValueCache<?> cache,
                              PVAChannelHandler channel)

Description copied from interface: DataSourceTypeAdapter

The parameters required to open a monitor for the channel. The type of the parameters will be datasource specific

For channels multiplexed on a single subscription, this method is never used.

Specified by:

getSubscriptionParameter in interface DataSourceTypeAdapter<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

cache - the cache where data will need to be written

channel - the connection information

Returns:

datasource specific subscription information

updateCache

public boolean updateCache(ValueCache cache,
                  PVAChannelHandler channel,
                  org.epics.pvdata.pv.PVStructure message)

Description copied from interface: DataSourceTypeAdapter

Takes the information in the message and updates the cache.

Specified by:

updateCache in interface DataSourceTypeAdapter<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

cache - cache to be updated

channel - the connection information

message - the payload of each message

Returns:

true if a new value was stored

createValue

public abstract Object createValue(org.epics.pvdata.pv.PVStructure message,
                 org.epics.pvdata.pv.PVField valueField,
                 boolean disconnected)

Given the value create the new value.

Parameters:

message - the value taken from the monitor

valueField - the value field data, optional

disconnected - true if the value should report the channel is currently disconnected

Returns:

the new value

toString

public String toString()

Overrides:

toString in class Object