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






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



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













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




public class NXquadrupole_magnetImpl
extends NXobjectImpl
implements NXquadrupole_magnet
definition for a quadrupole magnet.

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.NXquadrupole_magnet
NX_BEAMLINE_DISTANCE, NX_DESCRIPTION, NX_SET_CURRENT





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








Constructor Summary

Constructors 

Constructor and Description


NXquadrupole_magnetImpl() 


NXquadrupole_magnetImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getBeamline_distance()
define position of beamline element relative to production target



java.lang.Double
getBeamline_distanceScalar()
define position of beamline element relative to production target



IDataset
getDescription()
extended description of the magnet.



java.lang.String
getDescriptionScalar()
extended description of the magnet.



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.



NXlog
getRead_current()
current read from supply.



NXlog
getRead_voltage()
voltage read from supply.



IDataset
getSet_current()
current set on supply.



java.lang.Double
getSet_currentScalar()
current set on supply.



DataNode
setBeamline_distance(IDataset beamline_distance)
define position of beamline element relative to production target



DataNode
setBeamline_distanceScalar(java.lang.Double beamline_distance)
define position of beamline element relative to production target



DataNode
setDescription(IDataset description)
extended description of the magnet.



DataNode
setDescriptionScalar(java.lang.String description)
extended description of the magnet.



void
setRead_current(NXlog read_current)
current read from supply.



void
setRead_voltage(NXlog read_voltage)
voltage read from supply.



DataNode
setSet_current(IDataset set_current)
current set on supply.



DataNode
setSet_currentScalar(java.lang.Double set_current)
current set on supply.







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





NXquadrupole_magnetImpl
public NXquadrupole_magnetImpl()







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








getDescription
public IDataset getDescription()
Description copied from interface: NXquadrupole_magnet
extended description of the magnet.
 
 Type: NX_CHAR
 

Specified by:
getDescription in interface NXquadrupole_magnet
Returns:
the value.








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXquadrupole_magnet
extended description of the magnet.
 
 Type: NX_CHAR
 

Specified by:
getDescriptionScalar in interface NXquadrupole_magnet
Returns:
the value.








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXquadrupole_magnet
extended description of the magnet.
 
 Type: NX_CHAR
 

Specified by:
setDescription in interface NXquadrupole_magnet
Parameters:
description - the description








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXquadrupole_magnet
extended description of the magnet.
 
 Type: NX_CHAR
 

Specified by:
setDescriptionScalar in interface NXquadrupole_magnet
Parameters:
description - the description








getBeamline_distance
public IDataset getBeamline_distance()
Description copied from interface: NXquadrupole_magnet
define position of beamline element relative to production target
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBeamline_distance in interface NXquadrupole_magnet
Returns:
the value.








getBeamline_distanceScalar
public java.lang.Double getBeamline_distanceScalar()
Description copied from interface: NXquadrupole_magnet
define position of beamline element relative to production target
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBeamline_distanceScalar in interface NXquadrupole_magnet
Returns:
the value.








setBeamline_distance
public DataNode setBeamline_distance(IDataset beamline_distance)
Description copied from interface: NXquadrupole_magnet
define position of beamline element relative to production target
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBeamline_distance in interface NXquadrupole_magnet
Parameters:
beamline_distance - the beamline_distance








setBeamline_distanceScalar
public DataNode setBeamline_distanceScalar(java.lang.Double beamline_distance)
Description copied from interface: NXquadrupole_magnet
define position of beamline element relative to production target
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBeamline_distanceScalar in interface NXquadrupole_magnet
Parameters:
beamline_distance - the beamline_distance








getSet_current
public IDataset getSet_current()
Description copied from interface: NXquadrupole_magnet
current set on supply.
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getSet_current in interface NXquadrupole_magnet
Returns:
the value.








getSet_currentScalar
public java.lang.Double getSet_currentScalar()
Description copied from interface: NXquadrupole_magnet
current set on supply.
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getSet_currentScalar in interface NXquadrupole_magnet
Returns:
the value.








setSet_current
public DataNode setSet_current(IDataset set_current)
Description copied from interface: NXquadrupole_magnet
current set on supply.
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setSet_current in interface NXquadrupole_magnet
Parameters:
set_current - the set_current








setSet_currentScalar
public DataNode setSet_currentScalar(java.lang.Double set_current)
Description copied from interface: NXquadrupole_magnet
current set on supply.
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setSet_currentScalar in interface NXquadrupole_magnet
Parameters:
set_current - the set_current








getRead_current
public NXlog getRead_current()
Description copied from interface: NXquadrupole_magnet
current read from supply.

Specified by:
getRead_current in interface NXquadrupole_magnet
Returns:
the value.








setRead_current
public void setRead_current(NXlog read_current)
Description copied from interface: NXquadrupole_magnet
current read from supply.

Specified by:
setRead_current in interface NXquadrupole_magnet
Parameters:
read_current - the read_current








getRead_voltage
public NXlog getRead_voltage()
Description copied from interface: NXquadrupole_magnet
voltage read from supply.

Specified by:
getRead_voltage in interface NXquadrupole_magnet
Returns:
the value.








setRead_voltage
public void setRead_voltage(NXlog read_voltage)
Description copied from interface: NXquadrupole_magnet
voltage read from supply.

Specified by:
setRead_voltage in interface NXquadrupole_magnet
Parameters:
read_voltage - the read_voltage














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`	`getBeamline_distance()` define position of beamline element relative to production target
`java.lang.Double`	`getBeamline_distanceScalar()` define position of beamline element relative to production target
`IDataset`	`getDescription()` extended description of the magnet.
`java.lang.String`	`getDescriptionScalar()` extended description of the magnet.
`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.
`NXlog`	`getRead_current()` current read from supply.
`NXlog`	`getRead_voltage()` voltage read from supply.
`IDataset`	`getSet_current()` current set on supply.
`java.lang.Double`	`getSet_currentScalar()` current set on supply.
`DataNode`	`setBeamline_distance(IDataset beamline_distance)` define position of beamline element relative to production target
`DataNode`	`setBeamline_distanceScalar(java.lang.Double beamline_distance)` define position of beamline element relative to production target
`DataNode`	`setDescription(IDataset description)` extended description of the magnet.
`DataNode`	`setDescriptionScalar(java.lang.String description)` extended description of the magnet.
`void`	`setRead_current(NXlog read_current)` current read from supply.
`void`	`setRead_voltage(NXlog read_voltage)` voltage read from supply.
`DataNode`	`setSet_current(IDataset set_current)` current set on supply.
`DataNode`	`setSet_currentScalar(java.lang.Double set_current)` current set on supply.

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