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






NXdetector_groupImpl (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.impl
Class NXdetector_groupImpl



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXdetector_groupImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXdetector_group, NXobject




public class NXdetector_groupImpl
extends NXobjectImpl
implements NXdetector_group
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.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXdetector_group
NX_GROUP_INDEX, NX_GROUP_NAMES, NX_GROUP_PARENT, NX_GROUP_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXdetector_groupImpl() 


NXdetector_groupImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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.



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



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 class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





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





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





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, getNumber, 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





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXdetector_groupImpl
public NXdetector_groupImpl()







NXdetector_groupImpl
public NXdetector_groupImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getGroup_names
public IDataset getGroup_names()
Description copied from interface: NXdetector_group
Comma separated list of name

Specified by:
getGroup_names in interface NXdetector_group
Returns:
the value.








getGroup_namesScalar
public java.lang.String getGroup_namesScalar()
Description copied from interface: NXdetector_group
Comma separated list of name

Specified by:
getGroup_namesScalar in interface NXdetector_group
Returns:
the value.








setGroup_names
public DataNode setGroup_names(IDataset group_names)
Description copied from interface: NXdetector_group
Comma separated list of name

Specified by:
setGroup_names in interface NXdetector_group
Parameters:
group_names - the group_names








setGroup_namesScalar
public DataNode setGroup_namesScalar(java.lang.String group_names)
Description copied from interface: NXdetector_group
Comma separated list of name

Specified by:
setGroup_namesScalar in interface NXdetector_group
Parameters:
group_names - the group_names








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

Specified by:
getGroup_index in interface NXdetector_group
Returns:
the value.








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

Specified by:
getGroup_indexScalar in interface NXdetector_group
Returns:
the value.








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

Specified by:
setGroup_index in interface NXdetector_group
Parameters:
group_index - the group_index








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

Specified by:
setGroup_indexScalar in interface NXdetector_group
Parameters:
group_index - the group_index








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

Specified by:
getGroup_parent in interface NXdetector_group
Returns:
the value.








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

Specified by:
getGroup_parentScalar in interface NXdetector_group
Returns:
the value.








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

Specified by:
setGroup_parent in interface NXdetector_group
Parameters:
group_parent - the group_parent








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

Specified by:
setGroup_parentScalar in interface NXdetector_group
Parameters:
group_parent - the group_parent








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

Specified by:
getGroup_type in interface NXdetector_group
Returns:
the value.








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

Specified by:
getGroup_typeScalar in interface NXdetector_group
Returns:
the value.








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

Specified by:
setGroup_type in interface NXdetector_group
Parameters:
group_type - the group_type








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

Specified by:
setGroup_typeScalar in interface NXdetector_group
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	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.
`NexusBaseClass`	`getNexusBaseClass()` Enum constant from `NexusBaseClass` for this base class, e.g.
`java.lang.Class<? extends NXobject>`	`getNXclass()` Java `Class` object of the interface for this base class, e.g.
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`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.

Constructors
Constructor and Description
`NXdetector_groupImpl()`
`NXdetector_groupImpl(long oid)`