• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXpolarizerImpl.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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 NXpolarizerImpl



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.NXpolarizerImpl













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




public class NXpolarizerImpl
extends NXobjectImpl
implements NXpolarizer
A spin polarizer.

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.NXpolarizer
NX_COMPOSITION, NX_EFFICIENCY, NX_REFLECTION, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXpolarizerImpl() 


NXpolarizerImpl(long oid) 









Method Summary

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



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.



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





NXpolarizerImpl
public NXpolarizerImpl()







NXpolarizerImpl
public NXpolarizerImpl(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








getType
public IDataset getType()
Description copied from interface: NXpolarizer
one of these values: "crystal", "supermirror", "3He"

Specified by:
getType in interface NXpolarizer
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXpolarizer
one of these values: "crystal", "supermirror", "3He"

Specified by:
getTypeScalar in interface NXpolarizer
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXpolarizer
one of these values: "crystal", "supermirror", "3He"

Specified by:
setType in interface NXpolarizer
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXpolarizer
one of these values: "crystal", "supermirror", "3He"

Specified by:
setTypeScalar in interface NXpolarizer
Parameters:
type - the type








getComposition
public IDataset getComposition()
Description copied from interface: NXpolarizer
description of the composition of the polarizing material

Specified by:
getComposition in interface NXpolarizer
Returns:
the value.








getCompositionScalar
public java.lang.String getCompositionScalar()
Description copied from interface: NXpolarizer
description of the composition of the polarizing material

Specified by:
getCompositionScalar in interface NXpolarizer
Returns:
the value.








setComposition
public DataNode setComposition(IDataset composition)
Description copied from interface: NXpolarizer
description of the composition of the polarizing material

Specified by:
setComposition in interface NXpolarizer
Parameters:
composition - the composition








setCompositionScalar
public DataNode setCompositionScalar(java.lang.String composition)
Description copied from interface: NXpolarizer
description of the composition of the polarizing material

Specified by:
setCompositionScalar in interface NXpolarizer
Parameters:
composition - the composition








getReflection
public IDataset getReflection()
Description copied from interface: NXpolarizer
[hkl] values of nominal reflection
 

 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Specified by:
getReflection in interface NXpolarizer
Returns:
the value.








getReflectionScalar
public java.lang.Long getReflectionScalar()
Description copied from interface: NXpolarizer
[hkl] values of nominal reflection
 

 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Specified by:
getReflectionScalar in interface NXpolarizer
Returns:
the value.








setReflection
public DataNode setReflection(IDataset reflection)
Description copied from interface: NXpolarizer
[hkl] values of nominal reflection
 

 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Specified by:
setReflection in interface NXpolarizer
Parameters:
reflection - the reflection








setReflectionScalar
public DataNode setReflectionScalar(java.lang.Long reflection)
Description copied from interface: NXpolarizer
[hkl] values of nominal reflection
 

 Type: NX_INT
 Units: NX_UNITLESS
 Dimensions: 1: 3;
 

Specified by:
setReflectionScalar in interface NXpolarizer
Parameters:
reflection - the reflection








getEfficiency
public IDataset getEfficiency()
Description copied from interface: NXpolarizer
polarizing efficiency
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
getEfficiency in interface NXpolarizer
Returns:
the value.








getEfficiencyScalar
public java.lang.Double getEfficiencyScalar()
Description copied from interface: NXpolarizer
polarizing efficiency
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
getEfficiencyScalar in interface NXpolarizer
Returns:
the value.








setEfficiency
public DataNode setEfficiency(IDataset efficiency)
Description copied from interface: NXpolarizer
polarizing efficiency
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
setEfficiency in interface NXpolarizer
Parameters:
efficiency - the efficiency








setEfficiencyScalar
public DataNode setEfficiencyScalar(java.lang.Double efficiency)
Description copied from interface: NXpolarizer
polarizing efficiency
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Specified by:
setEfficiencyScalar in interface NXpolarizer
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