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






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXenvironmentImpl




public interface NXenvironment
extends NXobject
Parameters for controlling external conditions











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_NAME 


static java.lang.String
NX_PROGRAM 


static java.lang.String
NX_SHORT_NAME 


static java.lang.String
NX_TYPE 






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








Method Summary

All Methods Instance Methods Abstract 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.



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
 



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





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





NX_NAME
static final java.lang.String NX_NAME

See Also:
Constant Field Values








NX_SHORT_NAME
static final java.lang.String NX_SHORT_NAME

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_PROGRAM
static final java.lang.String NX_PROGRAM

See Also:
Constant Field Values










Method Detail





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

Returns:
the value.








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

Parameters:
name - the name








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

Returns:
the value.








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

Parameters:
name - the name








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

Returns:
the value.








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

Parameters:
short_name - the short_name








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

Returns:
the value.








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

Parameters:
short_name - the short_name








getType
IDataset getType()
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

Returns:
the value.








setType
DataNode setType(IDataset type)
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100

Parameters:
type - the type








getDescription
IDataset getDescription()
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump

Returns:
the value.








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

Parameters:
description - the description








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

Returns:
the value.








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

Parameters:
program - the program








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

Returns:
the value.








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

Parameters:
program - the program








getPosition
NXgeometry getPosition()
The position and orientation of the apparatus

Returns:
the value.








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

Parameters:
position - the position








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

Returns:
the value.








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

Parameters:
note - the note








getNote
NXnote getNote(java.lang.String name)
Get a NXnote node by name:
 

 

 Additional information, LabView logs, digital photographs, etc
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXnote for that node.








setNote
void setNote(java.lang.String name,
             NXnote note)
Set a NXnote node by name:
 

 

 Additional information, LabView logs, digital photographs, etc
 

Parameters:
name - the name of the node
note - the value to set








getAllNote
java.util.Map<java.lang.String,NXnote> getAllNote()
Get all NXnote nodes:
 

 

 Additional information, LabView logs, digital photographs, etc
 

Returns:
a map from node names to the NXnote for that node.








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

 

 Additional information, LabView logs, digital photographs, etc
 

Parameters:
note - the child nodes to add








getSensor
NXsensor getSensor()

Returns:
the value.








setSensor
void setSensor(NXsensor sensor)

Parameters:
sensor - the sensor








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

 

 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXsensor for that node.








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

 

 

Parameters:
name - the name of the node
sensor - the value to set








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

 

 

Returns:
a map from node names to the NXsensor for that node.








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

 

 

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