generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXdetector_group.html Maven / Gradle / Ivy






NXdetector_group (h5jan API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus
Interface NXdetector_group






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXdetector_groupImpl




public interface NXdetector_group
extends NXobject
Logical grouping of detector elements.
 This class is used to allow a logical
 grouping of detector elements (e.g. which tube, bank or group of banks) to be
 recorded in the file. As well as allowing you to e.g just select the "left" or
 "east" detectors, it may also be useful for determining which elements belong to the
 same PSD tube and hence have e.g. the same dead time.
 For example, if we had "bank1" composed
 of "tube1", "tube2" and "tube3" then group_names would be the string "bank1,
 bank1/tube1, bank1/tube2,bank1/tube3" group_index would be {1,2,3,4} group_parent
 would be {-1,1,1,1}
 The mapping array is interpreted as
 group 1 is a top level group containing groups 2, 3 and 4
 A ``group_index`` array in
 ``NXdetector`` gives the base group for a detector element.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_GROUP_INDEX 


static java.lang.String
NX_GROUP_NAMES 


static java.lang.String
NX_GROUP_PARENT 


static java.lang.String
NX_GROUP_TYPE 






Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


IDataset
getGroup_index()
Unique ID for group.



java.lang.Long
getGroup_indexScalar()
Unique ID for group.



IDataset
getGroup_names()
Comma separated list of name



java.lang.String
getGroup_namesScalar()
Comma separated list of name



IDataset
getGroup_parent()
Index of group parent in the hierarchy: -1 means no parent (i.e.



java.lang.Long
getGroup_parentScalar()
Index of group parent in the hierarchy: -1 means no parent (i.e.



IDataset
getGroup_type()
Code number for group type, e.g.



java.lang.Long
getGroup_typeScalar()
Code number for group type, e.g.



DataNode
setGroup_index(IDataset group_index)
Unique ID for group.



DataNode
setGroup_indexScalar(java.lang.Long group_index)
Unique ID for group.



DataNode
setGroup_names(IDataset group_names)
Comma separated list of name



DataNode
setGroup_namesScalar(java.lang.String group_names)
Comma separated list of name



DataNode
setGroup_parent(IDataset group_parent)
Index of group parent in the hierarchy: -1 means no parent (i.e.



DataNode
setGroup_parentScalar(java.lang.Long group_parent)
Index of group parent in the hierarchy: -1 means no parent (i.e.



DataNode
setGroup_type(IDataset group_type)
Code number for group type, e.g.



DataNode
setGroup_typeScalar(java.lang.Long group_type)
Code number for group type, e.g.







Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





NX_GROUP_NAMES
static final java.lang.String NX_GROUP_NAMES

See Also:
Constant Field Values








NX_GROUP_INDEX
static final java.lang.String NX_GROUP_INDEX

See Also:
Constant Field Values








NX_GROUP_PARENT
static final java.lang.String NX_GROUP_PARENT

See Also:
Constant Field Values








NX_GROUP_TYPE
static final java.lang.String NX_GROUP_TYPE

See Also:
Constant Field Values










Method Detail





getGroup_names
IDataset getGroup_names()
Comma separated list of name

Returns:
the value.








setGroup_names
DataNode setGroup_names(IDataset group_names)
Comma separated list of name

Parameters:
group_names - the group_names








getGroup_namesScalar
java.lang.String getGroup_namesScalar()
Comma separated list of name

Returns:
the value.








setGroup_namesScalar
DataNode setGroup_namesScalar(java.lang.String group_names)
Comma separated list of name

Parameters:
group_names - the group_names








getGroup_index
IDataset getGroup_index()
Unique ID for group. A group_index array
 in ``NXdetector`` gives the base group for a detector element.
 
 Type: NX_INT
 Dimensions: 1: i;
 

Returns:
the value.








setGroup_index
DataNode setGroup_index(IDataset group_index)
Unique ID for group. A group_index array
 in ``NXdetector`` gives the base group for a detector element.
 
 Type: NX_INT
 Dimensions: 1: i;
 

Parameters:
group_index - the group_index








getGroup_indexScalar
java.lang.Long getGroup_indexScalar()
Unique ID for group. A group_index array
 in ``NXdetector`` gives the base group for a detector element.
 
 Type: NX_INT
 Dimensions: 1: i;
 

Returns:
the value.








setGroup_indexScalar
DataNode setGroup_indexScalar(java.lang.Long group_index)
Unique ID for group. A group_index array
 in ``NXdetector`` gives the base group for a detector element.
 
 Type: NX_INT
 Dimensions: 1: i;
 

Parameters:
group_index - the group_index








getGroup_parent
IDataset getGroup_parent()
Index of group parent in the hierarchy: -1 means no parent (i.e. a top level) group
 
 Type: NX_INT
 Dimensions: 1: ;
 

Returns:
the value.








setGroup_parent
DataNode setGroup_parent(IDataset group_parent)
Index of group parent in the hierarchy: -1 means no parent (i.e. a top level) group
 
 Type: NX_INT
 Dimensions: 1: ;
 

Parameters:
group_parent - the group_parent








getGroup_parentScalar
java.lang.Long getGroup_parentScalar()
Index of group parent in the hierarchy: -1 means no parent (i.e. a top level) group
 
 Type: NX_INT
 Dimensions: 1: ;
 

Returns:
the value.








setGroup_parentScalar
DataNode setGroup_parentScalar(java.lang.Long group_parent)
Index of group parent in the hierarchy: -1 means no parent (i.e. a top level) group
 
 Type: NX_INT
 Dimensions: 1: ;
 

Parameters:
group_parent - the group_parent








getGroup_type
IDataset getGroup_type()
Code number for group type, e.g. bank=1, tube=2 etc.
 
 Type: NX_INT
 Dimensions: 1: ;
 

Returns:
the value.








setGroup_type
DataNode setGroup_type(IDataset group_type)
Code number for group type, e.g. bank=1, tube=2 etc.
 
 Type: NX_INT
 Dimensions: 1: ;
 

Parameters:
group_type - the group_type








getGroup_typeScalar
java.lang.Long getGroup_typeScalar()
Code number for group type, e.g. bank=1, tube=2 etc.
 
 Type: NX_INT
 Dimensions: 1: ;
 

Returns:
the value.








setGroup_typeScalar
DataNode setGroup_typeScalar(java.lang.Long group_type)
Code number for group type, e.g. bank=1, tube=2 etc.
 
 Type: NX_INT
 Dimensions: 1: ;
 

Parameters:
group_type - the group_type














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Modifier and Type	Field and Description
`static java.lang.String`	`NX_GROUP_INDEX`
`static java.lang.String`	`NX_GROUP_NAMES`
`static java.lang.String`	`NX_GROUP_PARENT`
`static java.lang.String`	`NX_GROUP_TYPE`

Modifier and Type	Method and Description
`IDataset`	`getGroup_index()` Unique ID for group.
`java.lang.Long`	`getGroup_indexScalar()` Unique ID for group.
`IDataset`	`getGroup_names()` Comma separated list of name
`java.lang.String`	`getGroup_namesScalar()` Comma separated list of name
`IDataset`	`getGroup_parent()` Index of group parent in the hierarchy: -1 means no parent (i.e.
`java.lang.Long`	`getGroup_parentScalar()` Index of group parent in the hierarchy: -1 means no parent (i.e.
`IDataset`	`getGroup_type()` Code number for group type, e.g.
`java.lang.Long`	`getGroup_typeScalar()` Code number for group type, e.g.
`DataNode`	`setGroup_index(IDataset group_index)` Unique ID for group.
`DataNode`	`setGroup_indexScalar(java.lang.Long group_index)` Unique ID for group.
`DataNode`	`setGroup_names(IDataset group_names)` Comma separated list of name
`DataNode`	`setGroup_namesScalar(java.lang.String group_names)` Comma separated list of name
`DataNode`	`setGroup_parent(IDataset group_parent)` Index of group parent in the hierarchy: -1 means no parent (i.e.
`DataNode`	`setGroup_parentScalar(java.lang.Long group_parent)` Index of group parent in the hierarchy: -1 means no parent (i.e.
`DataNode`	`setGroup_type(IDataset group_type)` Code number for group type, e.g.
`DataNode`	`setGroup_typeScalar(java.lang.Long group_type)` Code number for group type, e.g.