Package gda.data.metadata

Class EpicsMetadataEntry

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.data.metadata.MetadataEntry

gda.data.metadata.EpicsMetadataEntry

All Implemented Interfaces:

IMetadataEntry, Configurable, Findable, gda.observable.IObservable, Serializable

public class EpicsMetadataEntry
extends MetadataEntry

A MetadataEntry that gets it value by reading an EPICS PV.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static double	EPICS_TIMEOUT	The timeout for reading PVs referenced by metadata objects.

Constructor Summary

Constructors

Constructor	Description
EpicsMetadataEntry()	Creates an EPICS metadata entry.
EpicsMetadataEntry(String name, String pvName)	Creates an EPICS metadata entry with the specified name that will fetch the value of the specified PV.

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure Method.
String	readActualValue()	Returns the actual value of the metadata entry.
void	setPvName(String pvName)	Sets the PV from which this metadata entry will retrieve its value.

Methods inherited from class gda.data.metadata.MetadataEntry

addIObserver, canStoreValue, deleteIObserver, deleteIObservers, getDefEntryName, getMetadataValue, notifyIObservers, setDefEntryName, setValue, toString

Methods inherited from class gda.factory.FindableConfigurableBase

getName, setName

Methods inherited from class gda.factory.ConfigurableBase

isConfigureAtStartup, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.data.metadata.IMetadataEntry

getName, setName

Field Details

EPICS_TIMEOUT

protected static double EPICS_TIMEOUT

The timeout for reading PVs referenced by metadata objects.

Constructor Details

EpicsMetadataEntry

public EpicsMetadataEntry()

Creates an EPICS metadata entry.

EpicsMetadataEntry

public EpicsMetadataEntry(String name,
 String pvName)

Creates an EPICS metadata entry with the specified name that will fetch the value of the specified PV.

Parameters:

name - the metadata entry name

pvName - the EPICS PV name

Method Details

setPvName

public void setPvName(String pvName)

Sets the PV from which this metadata entry will retrieve its value.

Parameters:

pvName - the EPICS PV name

configure

public void configure()
               throws FactoryException

Description copied from class: MetadataEntry

Configure Method.

Specified by:

configure in interface Configurable

Overrides:

configure in class MetadataEntry

Throws:

FactoryException

readActualValue

public String readActualValue()
                       throws Exception

Description copied from class: MetadataEntry

Returns the actual value of the metadata entry. Any exception can be thrown by this method, which will cause MetadataEntry.getMetadataValue() to look for a default value (if one is specified).

Specified by:

readActualValue in class MetadataEntry

Returns:

the entry's actual value

Throws:

Exception - if the value cannot be retrieved