generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXflipper.html Maven / Gradle / Ivy
NXflipper (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXflipper
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
NX_COMP_CURRENT
static java.lang.String
NX_COMP_TURNS
static java.lang.String
NX_FLIP_CURRENT
static java.lang.String
NX_FLIP_TURNS
static java.lang.String
NX_GUIDE_CURRENT
static java.lang.String
NX_GUIDE_TURNS
static java.lang.String
NX_THICKNESS
static java.lang.String
NX_TYPE
-
Method Summary
All Methods Instance Methods Abstract 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
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 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
-
-
Field Detail
-
NX_TYPE
static final java.lang.String NX_TYPE
- See Also:
- Constant Field Values
-
NX_FLIP_TURNS
static final java.lang.String NX_FLIP_TURNS
- See Also:
- Constant Field Values
-
NX_COMP_TURNS
static final java.lang.String NX_COMP_TURNS
- See Also:
- Constant Field Values
-
NX_GUIDE_TURNS
static final java.lang.String NX_GUIDE_TURNS
- See Also:
- Constant Field Values
-
NX_FLIP_CURRENT
static final java.lang.String NX_FLIP_CURRENT
- See Also:
- Constant Field Values
-
NX_COMP_CURRENT
static final java.lang.String NX_COMP_CURRENT
- See Also:
- Constant Field Values
-
NX_GUIDE_CURRENT
static final java.lang.String NX_GUIDE_CURRENT
- See Also:
- Constant Field Values
-
NX_THICKNESS
static final java.lang.String NX_THICKNESS
- See Also:
- Constant Field Values
-
Method Detail
-
getType
IDataset getType()
Enumeration:
- coil
- current-sheet
- Returns:
- the value.
-
setType
DataNode setType(IDataset type)
Enumeration:
- coil
- current-sheet
- Parameters:
type
- the type
-
getTypeScalar
java.lang.String getTypeScalar()
Enumeration:
- coil
- current-sheet
- Returns:
- the value.
-
setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Enumeration:
- coil
- current-sheet
- Parameters:
type
- the type
-
getFlip_turns
IDataset getFlip_turns()
Linear density of turns (such as number of turns/cm) in flipping field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Returns:
- the value.
-
setFlip_turns
DataNode setFlip_turns(IDataset flip_turns)
Linear density of turns (such as number of turns/cm) in flipping field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Parameters:
flip_turns
- the flip_turns
-
getFlip_turnsScalar
java.lang.Double getFlip_turnsScalar()
Linear density of turns (such as number of turns/cm) in flipping field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Returns:
- the value.
-
setFlip_turnsScalar
DataNode setFlip_turnsScalar(java.lang.Double flip_turns)
Linear density of turns (such as number of turns/cm) in flipping field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Parameters:
flip_turns
- the flip_turns
-
getComp_turns
IDataset getComp_turns()
Linear density of turns (such as number of turns/cm) in compensating field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Returns:
- the value.
-
setComp_turns
DataNode setComp_turns(IDataset comp_turns)
Linear density of turns (such as number of turns/cm) in compensating field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Parameters:
comp_turns
- the comp_turns
-
getComp_turnsScalar
java.lang.Double getComp_turnsScalar()
Linear density of turns (such as number of turns/cm) in compensating field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Returns:
- the value.
-
setComp_turnsScalar
DataNode setComp_turnsScalar(java.lang.Double comp_turns)
Linear density of turns (such as number of turns/cm) in compensating field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Parameters:
comp_turns
- the comp_turns
-
getGuide_turns
IDataset getGuide_turns()
Linear density of turns (such as number of turns/cm) in guide field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Returns:
- the value.
-
setGuide_turns
DataNode setGuide_turns(IDataset guide_turns)
Linear density of turns (such as number of turns/cm) in guide field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Parameters:
guide_turns
- the guide_turns
-
getGuide_turnsScalar
java.lang.Double getGuide_turnsScalar()
Linear density of turns (such as number of turns/cm) in guide field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Returns:
- the value.
-
setGuide_turnsScalar
DataNode setGuide_turnsScalar(java.lang.Double guide_turns)
Linear density of turns (such as number of turns/cm) in guide field coils
Type: NX_FLOAT
Units: NX_PER_LENGTH
- Parameters:
guide_turns
- the guide_turns
-
getFlip_current
IDataset getFlip_current()
Flipping field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setFlip_current
DataNode setFlip_current(IDataset flip_current)
Flipping field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
flip_current
- the flip_current
-
getFlip_currentScalar
java.lang.Double getFlip_currentScalar()
Flipping field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setFlip_currentScalar
DataNode setFlip_currentScalar(java.lang.Double flip_current)
Flipping field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
flip_current
- the flip_current
-
getComp_current
IDataset getComp_current()
Compensating field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setComp_current
DataNode setComp_current(IDataset comp_current)
Compensating field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
comp_current
- the comp_current
-
getComp_currentScalar
java.lang.Double getComp_currentScalar()
Compensating field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setComp_currentScalar
DataNode setComp_currentScalar(java.lang.Double comp_current)
Compensating field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
comp_current
- the comp_current
-
getGuide_current
IDataset getGuide_current()
Guide field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setGuide_current
DataNode setGuide_current(IDataset guide_current)
Guide field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
guide_current
- the guide_current
-
getGuide_currentScalar
java.lang.Double getGuide_currentScalar()
Guide field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setGuide_currentScalar
DataNode setGuide_currentScalar(java.lang.Double guide_current)
Guide field coil current in "on" state"
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
guide_current
- the guide_current
-
getThickness
IDataset getThickness()
thickness along path of neutron travel
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setThickness
DataNode setThickness(IDataset thickness)
thickness along path of neutron travel
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
thickness
- the thickness
-
getThicknessScalar
java.lang.Double getThicknessScalar()
thickness along path of neutron travel
Type: NX_FLOAT
Units: NX_LENGTH
- Returns:
- the value.
-
setThicknessScalar
DataNode setThicknessScalar(java.lang.Double thickness)
thickness along path of neutron travel
Type: NX_FLOAT
Units: NX_LENGTH
- Parameters:
thickness
- the thickness