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






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



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













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




public class NXelectrostatic_kickerImpl
extends NXobjectImpl
implements NXelectrostatic_kicker
definition for a electrostatic kicker.

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.NXelectrostatic_kicker
NX_BEAMLINE_DISTANCE, NX_DESCRIPTION, NX_SET_CURRENT, NX_SET_VOLTAGE, NX_TIMING, NX_TIMING_ATTRIBUTE_DESCRIPTION





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








Constructor Summary

Constructors 

Constructor and Description


NXelectrostatic_kickerImpl() 


NXelectrostatic_kickerImpl(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 kicker.



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



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.



IDataset
getSet_voltage()
volage set on supply.



java.lang.Double
getSet_voltageScalar()
volage set on supply.



IDataset
getTiming()
kicker timing as defined by ``description`` attribute



java.lang.String
getTimingAttributeDescription() 


java.lang.Double
getTimingScalar()
kicker timing as defined by ``description`` attribute



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



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



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.



DataNode
setSet_voltage(IDataset set_voltage)
volage set on supply.



DataNode
setSet_voltageScalar(java.lang.Double set_voltage)
volage set on supply.



DataNode
setTiming(IDataset timing)
kicker timing as defined by ``description`` attribute



void
setTimingAttributeDescription(java.lang.String description) 


DataNode
setTimingScalar(java.lang.Double timing)
kicker timing as defined by ``description`` attribute







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





NXelectrostatic_kickerImpl
public NXelectrostatic_kickerImpl()







NXelectrostatic_kickerImpl
public NXelectrostatic_kickerImpl(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: NXelectrostatic_kicker
extended description of the kicker.
 
 Type: NX_CHAR
 

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








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

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








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

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








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

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








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

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








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

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








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

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








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

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








getTiming
public IDataset getTiming()
Description copied from interface: NXelectrostatic_kicker
kicker timing as defined by ``description`` attribute
 
 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getTiming in interface NXelectrostatic_kicker
Returns:
the value.








getTimingScalar
public java.lang.Double getTimingScalar()
Description copied from interface: NXelectrostatic_kicker
kicker timing as defined by ``description`` attribute
 
 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getTimingScalar in interface NXelectrostatic_kicker
Returns:
the value.








setTiming
public DataNode setTiming(IDataset timing)
Description copied from interface: NXelectrostatic_kicker
kicker timing as defined by ``description`` attribute
 
 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setTiming in interface NXelectrostatic_kicker
Parameters:
timing - the timing








setTimingScalar
public DataNode setTimingScalar(java.lang.Double timing)
Description copied from interface: NXelectrostatic_kicker
kicker timing as defined by ``description`` attribute
 
 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setTimingScalar in interface NXelectrostatic_kicker
Parameters:
timing - the timing








getTimingAttributeDescription
public java.lang.String getTimingAttributeDescription()

Specified by:
getTimingAttributeDescription in interface NXelectrostatic_kicker
Returns:
the value.








setTimingAttributeDescription
public void setTimingAttributeDescription(java.lang.String description)

Specified by:
setTimingAttributeDescription in interface NXelectrostatic_kicker
Parameters:
description - the description








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

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








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

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








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

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








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

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








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

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








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

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








getSet_voltage
public IDataset getSet_voltage()
Description copied from interface: NXelectrostatic_kicker
volage set on supply.
 
 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
getSet_voltage in interface NXelectrostatic_kicker
Returns:
the value.








getSet_voltageScalar
public java.lang.Double getSet_voltageScalar()
Description copied from interface: NXelectrostatic_kicker
volage set on supply.
 
 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
getSet_voltageScalar in interface NXelectrostatic_kicker
Returns:
the value.








setSet_voltage
public DataNode setSet_voltage(IDataset set_voltage)
Description copied from interface: NXelectrostatic_kicker
volage set on supply.
 
 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
setSet_voltage in interface NXelectrostatic_kicker
Parameters:
set_voltage - the set_voltage








setSet_voltageScalar
public DataNode setSet_voltageScalar(java.lang.Double set_voltage)
Description copied from interface: NXelectrostatic_kicker
volage set on supply.
 
 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Specified by:
setSet_voltageScalar in interface NXelectrostatic_kicker
Parameters:
set_voltage - the set_voltage








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

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








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

Specified by:
setRead_voltage in interface NXelectrostatic_kicker
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 kicker.
`java.lang.String`	`getDescriptionScalar()` extended description of the kicker.
`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.
`IDataset`	`getSet_voltage()` volage set on supply.
`java.lang.Double`	`getSet_voltageScalar()` volage set on supply.
`IDataset`	`getTiming()` kicker timing as defined by ``description`` attribute
`java.lang.String`	`getTimingAttributeDescription()`
`java.lang.Double`	`getTimingScalar()` kicker timing as defined by ``description`` attribute
`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 kicker.
`DataNode`	`setDescriptionScalar(java.lang.String description)` extended description of the kicker.
`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.
`DataNode`	`setSet_voltage(IDataset set_voltage)` volage set on supply.
`DataNode`	`setSet_voltageScalar(java.lang.Double set_voltage)` volage set on supply.
`DataNode`	`setTiming(IDataset timing)` kicker timing as defined by ``description`` attribute
`void`	`setTimingAttributeDescription(java.lang.String description)`
`DataNode`	`setTimingScalar(java.lang.Double timing)` kicker timing as defined by ``description`` attribute

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