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






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


All Known Implementing Classes:
NXapertureImpl




public interface NXaperture
extends NXobject
A beamline aperture.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_MATERIAL 






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,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 location and shape of aperture
 ..



java.util.Map<java.lang.String,NXnote>
getAllNote()
Get all NXnote nodes:
 
 
 describe any additional information in a note*
 



IDataset
getDescription()
Description of aperture



java.lang.String
getDescriptionScalar()
Description of aperture



NXgeometry
getGeometry()
location and shape of aperture
 ..



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 location and shape of aperture
 ..



IDataset
getMaterial()
Absorbing material of the aperture



java.lang.String
getMaterialScalar()
Absorbing material of the aperture



NXnote
getNote()
describe any additional information in a note*



NXnote
getNote(java.lang.String name)
Get a NXnote node by name:
 
 
 describe any additional information in a note*
 



void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.



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



DataNode
setDescription(IDataset description)
Description of aperture



DataNode
setDescriptionScalar(java.lang.String description)
Description of aperture



void
setGeometry(NXgeometry geometry)
location and shape of aperture
 ..



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 location and shape of aperture
 ..



DataNode
setMaterial(IDataset material)
Absorbing material of the aperture



DataNode
setMaterialScalar(java.lang.String material)
Absorbing material of the aperture



void
setNote(NXnote note)
describe any additional information in a note*



void
setNote(java.lang.String name,
       NXnote note)
Set a NXnote node by name:
 
 
 describe any additional information in a note*
 







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_MATERIAL
static final java.lang.String NX_MATERIAL

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values










Method Detail





getGeometry
NXgeometry getGeometry()
location and shape of aperture
 .. TODO: documentation needs improvement, contributions welcome
 * description of terms is poor and leaves much to interpretation
 * Describe what is meant by translation _here_ and ...
 * Similar throughout base classes
 * Some base classes do this much better
 * Such as where is the gap written?

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
location and shape of aperture
 .. TODO: documentation needs improvement, contributions welcome
 * description of terms is poor and leaves much to interpretation
 * Describe what is meant by translation _here_ and ...
 * Similar throughout base classes
 * Some base classes do this much better
 * Such as where is the gap written?

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 

 

 location and shape of aperture
 .. TODO: documentation needs improvement, contributions welcome
 * description of terms is poor and leaves much to interpretation
 * Describe what is meant by translation _here_ and ...
 * Similar throughout base classes
 * Some base classes do this much better
 * Such as where is the gap written?
 

 location and shape of each blade
 

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








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 

 

 location and shape of aperture
 .. TODO: documentation needs improvement, contributions welcome
 * description of terms is poor and leaves much to interpretation
 * Describe what is meant by translation _here_ and ...
 * Similar throughout base classes
 * Some base classes do this much better
 * Such as where is the gap written?
 

 location and shape of each blade
 

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








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 

 

 location and shape of aperture
 .. TODO: documentation needs improvement, contributions welcome
 * description of terms is poor and leaves much to interpretation
 * Describe what is meant by translation _here_ and ...
 * Similar throughout base classes
 * Some base classes do this much better
 * Such as where is the gap written?
 

 location and shape of each blade
 

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








setAllGeometry
void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
 

 

 location and shape of aperture
 .. TODO: documentation needs improvement, contributions welcome
 * description of terms is poor and leaves much to interpretation
 * Describe what is meant by translation _here_ and ...
 * Similar throughout base classes
 * Some base classes do this much better
 * Such as where is the gap written?
 

 location and shape of each blade
 

Parameters:
geometry - the child nodes to add








getMaterial
IDataset getMaterial()
Absorbing material of the aperture

Returns:
the value.








setMaterial
DataNode setMaterial(IDataset material)
Absorbing material of the aperture

Parameters:
material - the material








getMaterialScalar
java.lang.String getMaterialScalar()
Absorbing material of the aperture

Returns:
the value.








setMaterialScalar
DataNode setMaterialScalar(java.lang.String material)
Absorbing material of the aperture

Parameters:
material - the material








getDescription
IDataset getDescription()
Description of aperture

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
Description of aperture

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
Description of aperture

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
Description of aperture

Parameters:
description - the description








getNote
NXnote getNote()
describe any additional information in a note*

Returns:
the value.








setNote
void setNote(NXnote note)
describe any additional information in a note*

Parameters:
note - the note








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

 

 describe any additional information in a note*
 

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:
 

 

 describe any additional information in a note*
 

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:
 

 

 describe any additional information in a note*
 

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.
 

 

 describe any additional information in a note*
 

Parameters:
note - 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