• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXenvironmentImpl.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.NXenvironmentImpl.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 NXenvironmentImpl



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













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




public class NXenvironmentImpl
extends NXobjectImpl
implements NXenvironment
Parameters for controlling external conditions

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.NXenvironment
NX_DESCRIPTION, NX_NAME, NX_PROGRAM, NX_SHORT_NAME, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXenvironmentImpl() 


NXenvironmentImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXnote>
getAllNote()
Get all NXnote nodes:
 
 
 Additional information, LabView logs, digital photographs, etc
 



java.util.Map<java.lang.String,NXsensor>
getAllSensor()
Get all NXsensor nodes:
 
 
 



IDataset
getDescription()
Description of the apparatus; e.g.



java.lang.String
getDescriptionScalar()
Description of the apparatus; e.g.



IDataset
getName()
Apparatus identification code/model number; e.g.



java.lang.String
getNameScalar()
Apparatus identification code/model number; e.g.



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



NXnote
getNote()
Additional information, LabView logs, digital photographs, etc



NXnote
getNote(java.lang.String name)
Get a NXnote node by name:
 
 
 Additional information, LabView logs, digital photographs, etc
 



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.



NXgeometry
getPosition()
The position and orientation of the apparatus



IDataset
getProgram()
Program controlling the apparatus; e.g.



java.lang.String
getProgramScalar()
Program controlling the apparatus; e.g.



NXsensor
getSensor() 


NXsensor
getSensor(java.lang.String name)
Get a NXsensor node by name:
 
 
 



IDataset
getShort_name()
Alternative short name, perhaps for dashboard display like a present Seblock name



java.lang.String
getShort_nameScalar()
Alternative short name, perhaps for dashboard display like a present Seblock name



IDataset
getType()
Type of apparatus.



java.lang.String
getTypeScalar()
Type of apparatus.



void
setAllNote(java.util.Map<java.lang.String,NXnote> note)
Set multiple child nodes of a particular type.



void
setAllSensor(java.util.Map<java.lang.String,NXsensor> sensor)
Set multiple child nodes of a particular type.



DataNode
setDescription(IDataset description)
Description of the apparatus; e.g.



DataNode
setDescriptionScalar(java.lang.String description)
Description of the apparatus; e.g.



DataNode
setName(IDataset name)
Apparatus identification code/model number; e.g.



DataNode
setNameScalar(java.lang.String name)
Apparatus identification code/model number; e.g.



void
setNote(NXnote note)
Additional information, LabView logs, digital photographs, etc



void
setNote(java.lang.String name,
       NXnote note)
Set a NXnote node by name:
 
 
 Additional information, LabView logs, digital photographs, etc
 



void
setPosition(NXgeometry position)
The position and orientation of the apparatus



DataNode
setProgram(IDataset program)
Program controlling the apparatus; e.g.



DataNode
setProgramScalar(java.lang.String program)
Program controlling the apparatus; e.g.



void
setSensor(NXsensor sensor) 


void
setSensor(java.lang.String name,
         NXsensor sensor)
Set a NXsensor node by name:
 
 
 



DataNode
setShort_name(IDataset short_name)
Alternative short name, perhaps for dashboard display like a present Seblock name



DataNode
setShort_nameScalar(java.lang.String short_name)
Alternative short name, perhaps for dashboard display like a present Seblock name



DataNode
setType(IDataset type)
Type of apparatus.



DataNode
setTypeScalar(java.lang.String type)
Type of apparatus.







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





NXenvironmentImpl
public NXenvironmentImpl()







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








getName
public IDataset getName()
Description copied from interface: NXenvironment
Apparatus identification code/model number; e.g. OC100 011

Specified by:
getName in interface NXenvironment
Returns:
the value.








getNameScalar
public java.lang.String getNameScalar()
Description copied from interface: NXenvironment
Apparatus identification code/model number; e.g. OC100 011

Specified by:
getNameScalar in interface NXenvironment
Returns:
the value.








setName
public DataNode setName(IDataset name)
Description copied from interface: NXenvironment
Apparatus identification code/model number; e.g. OC100 011

Specified by:
setName in interface NXenvironment
Parameters:
name - the name








setNameScalar
public DataNode setNameScalar(java.lang.String name)
Description copied from interface: NXenvironment
Apparatus identification code/model number; e.g. OC100 011

Specified by:
setNameScalar in interface NXenvironment
Parameters:
name - the name








getShort_name
public IDataset getShort_name()
Description copied from interface: NXenvironment
Alternative short name, perhaps for dashboard display like a present Seblock name

Specified by:
getShort_name in interface NXenvironment
Returns:
the value.








getShort_nameScalar
public java.lang.String getShort_nameScalar()
Description copied from interface: NXenvironment
Alternative short name, perhaps for dashboard display like a present Seblock name

Specified by:
getShort_nameScalar in interface NXenvironment
Returns:
the value.








setShort_name
public DataNode setShort_name(IDataset short_name)
Description copied from interface: NXenvironment
Alternative short name, perhaps for dashboard display like a present Seblock name

Specified by:
setShort_name in interface NXenvironment
Parameters:
short_name - the short_name








setShort_nameScalar
public DataNode setShort_nameScalar(java.lang.String short_name)
Description copied from interface: NXenvironment
Alternative short name, perhaps for dashboard display like a present Seblock name

Specified by:
setShort_nameScalar in interface NXenvironment
Parameters:
short_name - the short_name








getType
public IDataset getType()
Description copied from interface: NXenvironment
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

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








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXenvironment
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

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








setType
public DataNode setType(IDataset type)
Description copied from interface: NXenvironment
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

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








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXenvironment
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

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








getDescription
public IDataset getDescription()
Description copied from interface: NXenvironment
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

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








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXenvironment
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

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








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXenvironment
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

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








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXenvironment
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

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








getProgram
public IDataset getProgram()
Description copied from interface: NXenvironment
Program controlling the apparatus; e.g. LabView VI name

Specified by:
getProgram in interface NXenvironment
Returns:
the value.








getProgramScalar
public java.lang.String getProgramScalar()
Description copied from interface: NXenvironment
Program controlling the apparatus; e.g. LabView VI name

Specified by:
getProgramScalar in interface NXenvironment
Returns:
the value.








setProgram
public DataNode setProgram(IDataset program)
Description copied from interface: NXenvironment
Program controlling the apparatus; e.g. LabView VI name

Specified by:
setProgram in interface NXenvironment
Parameters:
program - the program








setProgramScalar
public DataNode setProgramScalar(java.lang.String program)
Description copied from interface: NXenvironment
Program controlling the apparatus; e.g. LabView VI name

Specified by:
setProgramScalar in interface NXenvironment
Parameters:
program - the program








getPosition
public NXgeometry getPosition()
Description copied from interface: NXenvironment
The position and orientation of the apparatus

Specified by:
getPosition in interface NXenvironment
Returns:
the value.








setPosition
public void setPosition(NXgeometry position)
Description copied from interface: NXenvironment
The position and orientation of the apparatus

Specified by:
setPosition in interface NXenvironment
Parameters:
position - the position








getNote
public NXnote getNote()
Description copied from interface: NXenvironment
Additional information, LabView logs, digital photographs, etc

Specified by:
getNote in interface NXenvironment
Returns:
the value.








setNote
public void setNote(NXnote note)
Description copied from interface: NXenvironment
Additional information, LabView logs, digital photographs, etc

Specified by:
setNote in interface NXenvironment
Parameters:
note - the note








getNote
public NXnote getNote(java.lang.String name)
Description copied from interface: NXenvironment
Get a NXnote node by name:
 

 

 Additional information, LabView logs, digital photographs, etc
 

Specified by:
getNote in interface NXenvironment
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXnote for that node.








setNote
public void setNote(java.lang.String name,
                    NXnote note)
Description copied from interface: NXenvironment
Set a NXnote node by name:
 

 

 Additional information, LabView logs, digital photographs, etc
 

Specified by:
setNote in interface NXenvironment
Parameters:
name - the name of the node
note - the value to set








getAllNote
public java.util.Map<java.lang.String,NXnote> getAllNote()
Description copied from interface: NXenvironment
Get all NXnote nodes:
 

 

 Additional information, LabView logs, digital photographs, etc
 

Specified by:
getAllNote in interface NXenvironment
Returns:
a map from node names to the NXnote for that node.








setAllNote
public void setAllNote(java.util.Map<java.lang.String,NXnote> note)
Description copied from interface: NXenvironment
Set multiple child nodes of a particular type.
 

 

 Additional information, LabView logs, digital photographs, etc
 

Specified by:
setAllNote in interface NXenvironment
Parameters:
note - the child nodes to add








getSensor
public NXsensor getSensor()

Specified by:
getSensor in interface NXenvironment
Returns:
the value.








setSensor
public void setSensor(NXsensor sensor)

Specified by:
setSensor in interface NXenvironment
Parameters:
sensor - the sensor








getSensor
public NXsensor getSensor(java.lang.String name)
Description copied from interface: NXenvironment
Get a NXsensor node by name:
 

 

 

Specified by:
getSensor in interface NXenvironment
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXsensor for that node.








setSensor
public void setSensor(java.lang.String name,
                      NXsensor sensor)
Description copied from interface: NXenvironment
Set a NXsensor node by name:
 

 

 

Specified by:
setSensor in interface NXenvironment
Parameters:
name - the name of the node
sensor - the value to set








getAllSensor
public java.util.Map<java.lang.String,NXsensor> getAllSensor()
Description copied from interface: NXenvironment
Get all NXsensor nodes:
 

 

 

Specified by:
getAllSensor in interface NXenvironment
Returns:
a map from node names to the NXsensor for that node.








setAllSensor
public void setAllSensor(java.util.Map<java.lang.String,NXsensor> sensor)
Description copied from interface: NXenvironment
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllSensor in interface NXenvironment
Parameters:
sensor - the child nodes to add














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