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






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



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













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




public class NXflipperImpl
extends NXobjectImpl
implements NXflipper
A spin flipper.

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.NXflipper
NX_COMP_CURRENT, NX_COMP_TURNS, NX_FLIP_CURRENT, NX_FLIP_TURNS, NX_GUIDE_CURRENT, NX_GUIDE_TURNS, NX_THICKNESS, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXflipperImpl() 


NXflipperImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getComp_current()
Compensating field coil current in "on" state"



java.lang.Double
getComp_currentScalar()
Compensating field coil current in "on" state"



IDataset
getComp_turns()
Linear density of turns (such as number of turns/cm) in compensating field coils



java.lang.Double
getComp_turnsScalar()
Linear density of turns (such as number of turns/cm) in compensating field coils



IDataset
getFlip_current()
Flipping field coil current in "on" state"



java.lang.Double
getFlip_currentScalar()
Flipping field coil current in "on" state"



IDataset
getFlip_turns()
Linear density of turns (such as number of turns/cm) in flipping field coils



java.lang.Double
getFlip_turnsScalar()
Linear density of turns (such as number of turns/cm) in flipping field coils



IDataset
getGuide_current()
Guide field coil current in "on" state"



java.lang.Double
getGuide_currentScalar()
Guide field coil current in "on" state"



IDataset
getGuide_turns()
Linear density of turns (such as number of turns/cm) in guide field coils



java.lang.Double
getGuide_turnsScalar()
Linear density of turns (such as number of turns/cm) in guide field coils



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
getThickness()
thickness along path of neutron travel



java.lang.Double
getThicknessScalar()
thickness along path of neutron travel



IDataset
getType()


java.lang.String
getTypeScalar()


DataNode
setComp_current(IDataset comp_current)
Compensating field coil current in "on" state"



DataNode
setComp_currentScalar(java.lang.Double comp_current)
Compensating field coil current in "on" state"



DataNode
setComp_turns(IDataset comp_turns)
Linear density of turns (such as number of turns/cm) in compensating field coils



DataNode
setComp_turnsScalar(java.lang.Double comp_turns)
Linear density of turns (such as number of turns/cm) in compensating field coils



DataNode
setFlip_current(IDataset flip_current)
Flipping field coil current in "on" state"



DataNode
setFlip_currentScalar(java.lang.Double flip_current)
Flipping field coil current in "on" state"



DataNode
setFlip_turns(IDataset flip_turns)
Linear density of turns (such as number of turns/cm) in flipping field coils



DataNode
setFlip_turnsScalar(java.lang.Double flip_turns)
Linear density of turns (such as number of turns/cm) in flipping field coils



DataNode
setGuide_current(IDataset guide_current)
Guide field coil current in "on" state"



DataNode
setGuide_currentScalar(java.lang.Double guide_current)
Guide field coil current in "on" state"



DataNode
setGuide_turns(IDataset guide_turns)
Linear density of turns (such as number of turns/cm) in guide field coils



DataNode
setGuide_turnsScalar(java.lang.Double guide_turns)
Linear density of turns (such as number of turns/cm) in guide field coils



DataNode
setThickness(IDataset thickness)
thickness along path of neutron travel



DataNode
setThicknessScalar(java.lang.Double thickness)
thickness along path of neutron travel



DataNode
setType(IDataset type)


DataNode
setTypeScalar(java.lang.String type)






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





NXflipperImpl
public NXflipperImpl()







NXflipperImpl
public NXflipperImpl(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: NXflipper

 
Enumeration:

 coil 
 current-sheet 

 

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








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXflipper

 
Enumeration:

 coil 
 current-sheet 

 

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








setType
public DataNode setType(IDataset type)
Description copied from interface: NXflipper

 
Enumeration:

 coil 
 current-sheet 

 

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








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXflipper

 
Enumeration:

 coil 
 current-sheet 

 

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








getFlip_turns
public IDataset getFlip_turns()
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in flipping field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
getFlip_turns in interface NXflipper
Returns:
the value.








getFlip_turnsScalar
public java.lang.Double getFlip_turnsScalar()
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in flipping field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
getFlip_turnsScalar in interface NXflipper
Returns:
the value.








setFlip_turns
public DataNode setFlip_turns(IDataset flip_turns)
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in flipping field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
setFlip_turns in interface NXflipper
Parameters:
flip_turns - the flip_turns








setFlip_turnsScalar
public DataNode setFlip_turnsScalar(java.lang.Double flip_turns)
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in flipping field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
setFlip_turnsScalar in interface NXflipper
Parameters:
flip_turns - the flip_turns








getComp_turns
public IDataset getComp_turns()
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in compensating field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
getComp_turns in interface NXflipper
Returns:
the value.








getComp_turnsScalar
public java.lang.Double getComp_turnsScalar()
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in compensating field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
getComp_turnsScalar in interface NXflipper
Returns:
the value.








setComp_turns
public DataNode setComp_turns(IDataset comp_turns)
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in compensating field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
setComp_turns in interface NXflipper
Parameters:
comp_turns - the comp_turns








setComp_turnsScalar
public DataNode setComp_turnsScalar(java.lang.Double comp_turns)
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in compensating field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
setComp_turnsScalar in interface NXflipper
Parameters:
comp_turns - the comp_turns








getGuide_turns
public IDataset getGuide_turns()
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in guide field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
getGuide_turns in interface NXflipper
Returns:
the value.








getGuide_turnsScalar
public java.lang.Double getGuide_turnsScalar()
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in guide field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
getGuide_turnsScalar in interface NXflipper
Returns:
the value.








setGuide_turns
public DataNode setGuide_turns(IDataset guide_turns)
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in guide field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
setGuide_turns in interface NXflipper
Parameters:
guide_turns - the guide_turns








setGuide_turnsScalar
public DataNode setGuide_turnsScalar(java.lang.Double guide_turns)
Description copied from interface: NXflipper
Linear density of turns (such as number of turns/cm) in guide field coils
 
 Type: NX_FLOAT
 Units: NX_PER_LENGTH
 

Specified by:
setGuide_turnsScalar in interface NXflipper
Parameters:
guide_turns - the guide_turns








getFlip_current
public IDataset getFlip_current()
Description copied from interface: NXflipper
Flipping field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getFlip_current in interface NXflipper
Returns:
the value.








getFlip_currentScalar
public java.lang.Double getFlip_currentScalar()
Description copied from interface: NXflipper
Flipping field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getFlip_currentScalar in interface NXflipper
Returns:
the value.








setFlip_current
public DataNode setFlip_current(IDataset flip_current)
Description copied from interface: NXflipper
Flipping field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setFlip_current in interface NXflipper
Parameters:
flip_current - the flip_current








setFlip_currentScalar
public DataNode setFlip_currentScalar(java.lang.Double flip_current)
Description copied from interface: NXflipper
Flipping field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setFlip_currentScalar in interface NXflipper
Parameters:
flip_current - the flip_current








getComp_current
public IDataset getComp_current()
Description copied from interface: NXflipper
Compensating field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getComp_current in interface NXflipper
Returns:
the value.








getComp_currentScalar
public java.lang.Double getComp_currentScalar()
Description copied from interface: NXflipper
Compensating field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getComp_currentScalar in interface NXflipper
Returns:
the value.








setComp_current
public DataNode setComp_current(IDataset comp_current)
Description copied from interface: NXflipper
Compensating field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setComp_current in interface NXflipper
Parameters:
comp_current - the comp_current








setComp_currentScalar
public DataNode setComp_currentScalar(java.lang.Double comp_current)
Description copied from interface: NXflipper
Compensating field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setComp_currentScalar in interface NXflipper
Parameters:
comp_current - the comp_current








getGuide_current
public IDataset getGuide_current()
Description copied from interface: NXflipper
Guide field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getGuide_current in interface NXflipper
Returns:
the value.








getGuide_currentScalar
public java.lang.Double getGuide_currentScalar()
Description copied from interface: NXflipper
Guide field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getGuide_currentScalar in interface NXflipper
Returns:
the value.








setGuide_current
public DataNode setGuide_current(IDataset guide_current)
Description copied from interface: NXflipper
Guide field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setGuide_current in interface NXflipper
Parameters:
guide_current - the guide_current








setGuide_currentScalar
public DataNode setGuide_currentScalar(java.lang.Double guide_current)
Description copied from interface: NXflipper
Guide field coil current in "on" state"
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setGuide_currentScalar in interface NXflipper
Parameters:
guide_current - the guide_current








getThickness
public IDataset getThickness()
Description copied from interface: NXflipper
thickness along path of neutron travel
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getThickness in interface NXflipper
Returns:
the value.








getThicknessScalar
public java.lang.Double getThicknessScalar()
Description copied from interface: NXflipper
thickness along path of neutron travel
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getThicknessScalar in interface NXflipper
Returns:
the value.








setThickness
public DataNode setThickness(IDataset thickness)
Description copied from interface: NXflipper
thickness along path of neutron travel
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setThickness in interface NXflipper
Parameters:
thickness - the thickness








setThicknessScalar
public DataNode setThicknessScalar(java.lang.Double thickness)
Description copied from interface: NXflipper
thickness along path of neutron travel
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setThicknessScalar in interface NXflipper
Parameters:
thickness - the thickness














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`	`getComp_current()` Compensating field coil current in "on" state"
`java.lang.Double`	`getComp_currentScalar()` Compensating field coil current in "on" state"
`IDataset`	`getComp_turns()` Linear density of turns (such as number of turns/cm) in compensating field coils
`java.lang.Double`	`getComp_turnsScalar()` Linear density of turns (such as number of turns/cm) in compensating field coils
`IDataset`	`getFlip_current()` Flipping field coil current in "on" state"
`java.lang.Double`	`getFlip_currentScalar()` Flipping field coil current in "on" state"
`IDataset`	`getFlip_turns()` Linear density of turns (such as number of turns/cm) in flipping field coils
`java.lang.Double`	`getFlip_turnsScalar()` Linear density of turns (such as number of turns/cm) in flipping field coils
`IDataset`	`getGuide_current()` Guide field coil current in "on" state"
`java.lang.Double`	`getGuide_currentScalar()` Guide field coil current in "on" state"
`IDataset`	`getGuide_turns()` Linear density of turns (such as number of turns/cm) in guide field coils
`java.lang.Double`	`getGuide_turnsScalar()` Linear density of turns (such as number of turns/cm) in guide field coils
`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`	`getThickness()` thickness along path of neutron travel
`java.lang.Double`	`getThicknessScalar()` thickness along path of neutron travel
`IDataset`	`getType()`
`java.lang.String`	`getTypeScalar()`
`DataNode`	`setComp_current(IDataset comp_current)` Compensating field coil current in "on" state"
`DataNode`	`setComp_currentScalar(java.lang.Double comp_current)` Compensating field coil current in "on" state"
`DataNode`	`setComp_turns(IDataset comp_turns)` Linear density of turns (such as number of turns/cm) in compensating field coils
`DataNode`	`setComp_turnsScalar(java.lang.Double comp_turns)` Linear density of turns (such as number of turns/cm) in compensating field coils
`DataNode`	`setFlip_current(IDataset flip_current)` Flipping field coil current in "on" state"
`DataNode`	`setFlip_currentScalar(java.lang.Double flip_current)` Flipping field coil current in "on" state"
`DataNode`	`setFlip_turns(IDataset flip_turns)` Linear density of turns (such as number of turns/cm) in flipping field coils
`DataNode`	`setFlip_turnsScalar(java.lang.Double flip_turns)` Linear density of turns (such as number of turns/cm) in flipping field coils
`DataNode`	`setGuide_current(IDataset guide_current)` Guide field coil current in "on" state"
`DataNode`	`setGuide_currentScalar(java.lang.Double guide_current)` Guide field coil current in "on" state"
`DataNode`	`setGuide_turns(IDataset guide_turns)` Linear density of turns (such as number of turns/cm) in guide field coils
`DataNode`	`setGuide_turnsScalar(java.lang.Double guide_turns)` Linear density of turns (such as number of turns/cm) in guide field coils
`DataNode`	`setThickness(IDataset thickness)` thickness along path of neutron travel
`DataNode`	`setThicknessScalar(java.lang.Double thickness)` thickness along path of neutron travel
`DataNode`	`setType(IDataset type)`
`DataNode`	`setTypeScalar(java.lang.String type)`

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