Package gda.device.detector

Class EpicsProcessVariableCollection

java.lang.Object

gda.factory.FindableBase

gda.device.detector.EpicsProcessVariableCollection

All Implemented Interfaces:

Findable

public class EpicsProcessVariableCollection
extends FindableBase

specify extra data items to be collected in a scan. These data items can be set in maps defined in Spring beans using following methods:

• setName2PVNestedMap(Map) - this supports nested map in which data from PVs are further grouped into children nodes under this group before adding into containing node.
• setName2PVSimpleMap(Map) - this supports simple map in which data from all PVs are grouped together in this group before adding into containing node.
• setFieldsToAppend(Map) - this supports a multiple valued map in which data from different type items are added directly to the containing node.
• setName2PairMap(Map) - this supports a simple map in which data from different type items are grouped together before adding into containing node.

All of these maps are optional, that is if it is not empty, data from PVs within the map will be collected, otherwise nothing will be collected in data file.

For the last 2 methods, there are 4 different EpicsProcessVariableCollection.InputType of items can be specified in Spring beans - (EpicsProcessVariableCollection.InputType.CONSTANT, EpicsProcessVariableCollection.InputType.PV, EpicsProcessVariableCollection.InputType.LINK, EpicsProcessVariableCollection.InputType.EXPRESSION).

Important to know:

Objects of this class tolerant with any PV access failure so it will not block data collection from others. Instead of throwing exception when PV access fails, it returns the error message of the PV access problem as well as makes ERROR log entry in the log file.

Usage:

Instance of this class can be injected into file writer MultipleImagesPerHDF5FileWriter or MultipleHDF5PluginsPerDetectorFileWriter to contribute to the data collection. The original requirements are to capture active detector setting parameters during data collection with the detector.

Since:

23 March 2021

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EpicsProcessVariableCollection.InputType

Constructor Summary

Constructors

Constructor	Description
EpicsProcessVariableCollection()

Method Summary

Modifier and Type	Method	Description
void	addField(String name, EpicsProcessVariableCollection.InputType type, String value)	add specified filed with specified EpicsProcessVariableCollection.InputType and String value
void	addToNestedMap(String group, String name, String pvName)	add a key value pair to a specified group in the nested map
void	addToSimpleMap(String name, String pvName)	add a Key value pair to the simple map
Optional<Map<String,DataNode>>	createDataNodeToAppend()
Optional<Map<String,String>>	createFieldsToAppend()	return an Optional of a Map containing name-value maps which can be added to other Nexus node directly.
Optional<GroupNode>	createGroupNodeFromName2PairMap()	return an Optional of an INexusTree which can be added to other Nexus node.
Optional<GroupNode>	createGroupNodeFromName2PVNestedMap()	create an GroupNode as NXcollection from PV map specified in setName2PVNestedMap(Map) or setName2PVSimpleMap(Map).
Optional<GroupNode>	createGroupNodeFromName2PVSimpleMap()
Optional<INexusTree>	createNexusTreeFromName2PairMap(String name)	return an Optional of an INexusTree which can be added to other Nexus node.
Optional<INexusTree>	createNexusTreeFromName2PVNestedMap(String name)	create an of an INexusTree node as NXcollection from PV map specified in setName2PVNestedMap(Map)
Optional<INexusTree>	createNexusTreeFromName2PVSimpleMap(String name)	create an of an INexusTree node as NXcollection from PV map specified in setName2PVSimpleMap(Map)
void	displayFieldsToAppend()	display fields to append on Jython Terminal.
void	displayNestedMap()	display nested map content on Jython Terminal.
void	displaySimpleMap()	display simple map content on Jython Terminal.
boolean	equals(Object obj)
int	hashCode()
void	removeElementFromNamedField(String name, EpicsProcessVariableCollection.InputType type, String value)	remove a specific EpicsProcessVariableCollection.InputType and String value pair from the specified name field
List<org.apache.commons.lang3.tuple.ImmutablePair<EpicsProcessVariableCollection.InputType,String>>	removeField(String name)	remove a specified field from the map
String	removeFromNestedMap(String group, String name)	remove an item from the specified group of the nested map
String	removeFromSimpleMap(String name)	remove an item from the simple map
Map<String,String>	removeGroupFromNestedMap(String group)	remove a whole group from the nested map
void	setFieldsToAppend(Map<String,List<org.apache.commons.lang3.tuple.ImmutablePair<EpicsProcessVariableCollection.InputType,String>>> fieldsToAppend)	set a multi-valued map
void	setHDF5Filename(String expectedFullFileName)
void	setName2PairMap(Map<String,org.apache.commons.lang3.tuple.ImmutablePair<EpicsProcessVariableCollection.InputType,String>> name2PairMap)
void	setName2PVNestedMap(Map<String,Map<String,String>> name2pvNestedMap)	set a nested map
void	setName2PVSimpleMap(Map<String,String> name2pvSimpleMap)	set simple map

Methods inherited from class gda.factory.FindableBase

getName, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EpicsProcessVariableCollection

public EpicsProcessVariableCollection()

Method Details

addField

public void addField(String name,
 EpicsProcessVariableCollection.InputType type,
 String value)

add specified filed with specified EpicsProcessVariableCollection.InputType and String value

Parameters:

name - - field name, i.e. map key

type - - EpicsProcessVariableCollection.InputType of corresponding value

value - - the String of corresponding EpicsProcessVariableCollection.InputType

removeField

public List<org.apache.commons.lang3.tuple.ImmutablePair<EpicsProcessVariableCollection.InputType,String>> removeField(String name)

remove a specified field from the map

Parameters:

name - - field name

Returns:

the value of the field being removed

removeElementFromNamedField

public void removeElementFromNamedField(String name,
 EpicsProcessVariableCollection.InputType type,
 String value)

remove a specific EpicsProcessVariableCollection.InputType and String value pair from the specified name field

Parameters:

name - - field name, i.e. map key

type - - EpicsProcessVariableCollection.InputType of corresponding value

value - - the String of corresponding EpicsProcessVariableCollection.InputType

addToSimpleMap

public void addToSimpleMap(String name,
 String pvName)

add a Key value pair to the simple map

Parameters:

name - - GDA name as key

pvName - - PV name from which to get the value

removeFromSimpleMap

public String removeFromSimpleMap(String name)

remove an item from the simple map

Parameters:

name - - GDA name as key removed from map

Returns:

- the PV name removed from map

addToNestedMap

public void addToNestedMap(String group,
 String name,
 String pvName)

add a key value pair to a specified group in the nested map

Parameters:

group - - the key to the inner map

name - - the GDA name as key of the inner map

pvName - - the PV name as value of the inner map

removeFromNestedMap

public String removeFromNestedMap(String group,
 String name)

remove an item from the specified group of the nested map

Parameters:

group - - key to the inner map

name - - key of the inner map to be removed

Returns:

- the PB name removed from the inner map

removeGroupFromNestedMap

public Map<String,String> removeGroupFromNestedMap(String group)

remove a whole group from the nested map

Parameters:

group - - group to be removed

Returns:

- the map of the removed group

displaySimpleMap

public void displaySimpleMap()

display simple map content on Jython Terminal.

displayNestedMap

public void displayNestedMap()

display nested map content on Jython Terminal.

displayFieldsToAppend

public void displayFieldsToAppend()

display fields to append on Jython Terminal.

createFieldsToAppend

public Optional<Map<String,String>> createFieldsToAppend()

return an Optional of a Map containing name-value maps which can be added to other Nexus node directly.

Returns:

a map of name , value

createDataNodeToAppend

public Optional<Map<String,DataNode>> createDataNodeToAppend()

createNexusTreeFromName2PairMap

public Optional<INexusTree> createNexusTreeFromName2PairMap(String name)

return an Optional of an INexusTree which can be added to other Nexus node.

Returns:

a map of name , value

createNexusTreeFromName2PVNestedMap

public Optional<INexusTree> createNexusTreeFromName2PVNestedMap(String name)

create an of an INexusTree node as NXcollection from PV map specified in setName2PVNestedMap(Map)

Parameters:

name - the name of the tree node

Returns:

an Optional of an INexusTree node

createNexusTreeFromName2PVSimpleMap

public Optional<INexusTree> createNexusTreeFromName2PVSimpleMap(String name)

create an of an INexusTree node as NXcollection from PV map specified in setName2PVSimpleMap(Map)

Parameters:

name - the name of the tree node

Returns:

an Optional of an INexusTree node

createGroupNodeFromName2PairMap

public Optional<GroupNode> createGroupNodeFromName2PairMap()

return an Optional of an INexusTree which can be added to other Nexus node. The data source comes from setName2PairMap(Map) which can be set with setName2PairMap(Map)

Returns:

a map of name , value

createGroupNodeFromName2PVNestedMap

public Optional<GroupNode> createGroupNodeFromName2PVNestedMap()

create an GroupNode as NXcollection from PV map specified in setName2PVNestedMap(Map) or setName2PVSimpleMap(Map). This is used by new NexusScanDataWriter.

Returns:

a group node

createGroupNodeFromName2PVSimpleMap

public Optional<GroupNode> createGroupNodeFromName2PVSimpleMap()

setName2PVNestedMap

public void setName2PVNestedMap(Map<String,Map<String,String>> name2pvNestedMap)

set a nested map

Parameters:

name2pvNestedMap - - map of maps

setName2PVSimpleMap

public void setName2PVSimpleMap(Map<String,String> name2pvSimpleMap)

set simple map

Parameters:

name2pvSimpleMap - - map of GDA name to PV

setFieldsToAppend

public void setFieldsToAppend(Map<String,List<org.apache.commons.lang3.tuple.ImmutablePair<EpicsProcessVariableCollection.InputType,String>>> fieldsToAppend)

set a multi-valued map

Parameters:

fieldsToAppend -

setName2PairMap

public void setName2PairMap(Map<String,org.apache.commons.lang3.tuple.ImmutablePair<EpicsProcessVariableCollection.InputType,String>> name2PairMap)

hashCode

public int hashCode()

Overrides:

hashCode in class FindableBase

equals

public boolean equals(Object obj)

Overrides:

equals in class FindableBase

setHDF5Filename

public void setHDF5Filename(String expectedFullFileName)