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






NXpolarizer (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 NXpolarizer






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


All Known Implementing Classes:
NXpolarizerImpl




public interface NXpolarizer
extends NXobject
A spin polarizer.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_COMPOSITION 


static java.lang.String
NX_EFFICIENCY 


static java.lang.String
NX_REFLECTION 


static java.lang.String
NX_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
getComposition()
description of the composition of the polarizing material



java.lang.String
getCompositionScalar()
description of the composition of the polarizing material



IDataset
getEfficiency()
polarizing efficiency



java.lang.Double
getEfficiencyScalar()
polarizing efficiency



IDataset
getReflection()
[hkl] values of nominal reflection



java.lang.Long
getReflectionScalar()
[hkl] values of nominal reflection



IDataset
getType()
one of these values: "crystal", "supermirror", "3He"



java.lang.String
getTypeScalar()
one of these values: "crystal", "supermirror", "3He"



DataNode
setComposition(IDataset composition)
description of the composition of the polarizing material



DataNode
setCompositionScalar(java.lang.String composition)
description of the composition of the polarizing material



DataNode
setEfficiency(IDataset efficiency)
polarizing efficiency



DataNode
setEfficiencyScalar(java.lang.Double efficiency)
polarizing efficiency



DataNode
setReflection(IDataset reflection)
[hkl] values of nominal reflection



DataNode
setReflectionScalar(java.lang.Long reflection)
[hkl] values of nominal reflection



DataNode
setType(IDataset type)
one of these values: "crystal", "supermirror", "3He"



DataNode
setTypeScalar(java.lang.String type)
one of these values: "crystal", "supermirror", "3He"







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_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_COMPOSITION
static final java.lang.String NX_COMPOSITION

See Also:
Constant Field Values








NX_REFLECTION
static final java.lang.String NX_REFLECTION

See Also:
Constant Field Values








NX_EFFICIENCY
static final java.lang.String NX_EFFICIENCY

See Also:
Constant Field Values










Method Detail





getType
IDataset getType()
one of these values: "crystal", "supermirror", "3He"

Returns:
the value.








setType
DataNode setType(IDataset type)
one of these values: "crystal", "supermirror", "3He"

Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
one of these values: "crystal", "supermirror", "3He"

Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
one of these values: "crystal", "supermirror", "3He"

Parameters:
type - the type








getComposition
IDataset getComposition()
description of the composition of the polarizing material

Returns:
the value.








setComposition
DataNode setComposition(IDataset composition)
description of the composition of the polarizing material

Parameters:
composition - the composition








getCompositionScalar
java.lang.String getCompositionScalar()
description of the composition of the polarizing material

Returns:
the value.








setCompositionScalar
DataNode setCompositionScalar(java.lang.String composition)
description of the composition of the polarizing material

Parameters:
composition - the composition








getReflection
IDataset getReflection()
[hkl] values of nominal reflection
 
 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Returns:
the value.








setReflection
DataNode setReflection(IDataset reflection)
[hkl] values of nominal reflection
 
 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Parameters:
reflection - the reflection








getReflectionScalar
java.lang.Long getReflectionScalar()
[hkl] values of nominal reflection
 
 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Returns:
the value.








setReflectionScalar
DataNode setReflectionScalar(java.lang.Long reflection)
[hkl] values of nominal reflection
 
 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Parameters:
reflection - the reflection








getEfficiency
IDataset getEfficiency()
polarizing efficiency
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Returns:
the value.








setEfficiency
DataNode setEfficiency(IDataset efficiency)
polarizing efficiency
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Parameters:
efficiency - the efficiency








getEfficiencyScalar
java.lang.Double getEfficiencyScalar()
polarizing efficiency
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Returns:
the value.








setEfficiencyScalar
DataNode setEfficiencyScalar(java.lang.Double efficiency)
polarizing efficiency
 
 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Parameters:
efficiency - the efficiency














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_COMPOSITION`
`static java.lang.String`	`NX_EFFICIENCY`
`static java.lang.String`	`NX_REFLECTION`
`static java.lang.String`	`NX_TYPE`

Modifier and Type	Method and Description
`IDataset`	`getComposition()` description of the composition of the polarizing material
`java.lang.String`	`getCompositionScalar()` description of the composition of the polarizing material
`IDataset`	`getEfficiency()` polarizing efficiency
`java.lang.Double`	`getEfficiencyScalar()` polarizing efficiency
`IDataset`	`getReflection()` [hkl] values of nominal reflection
`java.lang.Long`	`getReflectionScalar()` [hkl] values of nominal reflection
`IDataset`	`getType()` one of these values: "crystal", "supermirror", "3He"
`java.lang.String`	`getTypeScalar()` one of these values: "crystal", "supermirror", "3He"
`DataNode`	`setComposition(IDataset composition)` description of the composition of the polarizing material
`DataNode`	`setCompositionScalar(java.lang.String composition)` description of the composition of the polarizing material
`DataNode`	`setEfficiency(IDataset efficiency)` polarizing efficiency
`DataNode`	`setEfficiencyScalar(java.lang.Double efficiency)` polarizing efficiency
`DataNode`	`setReflection(IDataset reflection)` [hkl] values of nominal reflection
`DataNode`	`setReflectionScalar(java.lang.Long reflection)` [hkl] values of nominal reflection
`DataNode`	`setType(IDataset type)` one of these values: "crystal", "supermirror", "3He"
`DataNode`	`setTypeScalar(java.lang.String type)` one of these values: "crystal", "supermirror", "3He"