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






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



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













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




public class NXapertureImpl
extends NXobjectImpl
implements NXaperture
A beamline aperture.

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.NXaperture
NX_DESCRIPTION, NX_MATERIAL





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








Constructor Summary

Constructors 

Constructor and Description


NXapertureImpl() 


NXapertureImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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



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



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*
 



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.



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





NXapertureImpl
public NXapertureImpl()







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








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXaperture
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?

Specified by:
getGeometry in interface NXaperture
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXaperture
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?

Specified by:
setGeometry in interface NXaperture
Parameters:
geometry - the geometry








getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXaperture
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
 

Specified by:
getGeometry in interface NXaperture
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








setGeometry
public void setGeometry(java.lang.String name,
                        NXgeometry geometry)
Description copied from interface: NXaperture
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
 

Specified by:
setGeometry in interface NXaperture
Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
public java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Description copied from interface: NXaperture
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
 

Specified by:
getAllGeometry in interface NXaperture
Returns:
a map from node names to the NXgeometry for that node.








setAllGeometry
public void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Description copied from interface: NXaperture
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
 

Specified by:
setAllGeometry in interface NXaperture
Parameters:
geometry - the child nodes to add








getMaterial
public IDataset getMaterial()
Description copied from interface: NXaperture
Absorbing material of the aperture

Specified by:
getMaterial in interface NXaperture
Returns:
the value.








getMaterialScalar
public java.lang.String getMaterialScalar()
Description copied from interface: NXaperture
Absorbing material of the aperture

Specified by:
getMaterialScalar in interface NXaperture
Returns:
the value.








setMaterial
public DataNode setMaterial(IDataset material)
Description copied from interface: NXaperture
Absorbing material of the aperture

Specified by:
setMaterial in interface NXaperture
Parameters:
material - the material








setMaterialScalar
public DataNode setMaterialScalar(java.lang.String material)
Description copied from interface: NXaperture
Absorbing material of the aperture

Specified by:
setMaterialScalar in interface NXaperture
Parameters:
material - the material








getDescription
public IDataset getDescription()
Description copied from interface: NXaperture
Description of aperture

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








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXaperture
Description of aperture

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








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXaperture
Description of aperture

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








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXaperture
Description of aperture

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








getNote
public NXnote getNote()
Description copied from interface: NXaperture
describe any additional information in a note*

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








setNote
public void setNote(NXnote note)
Description copied from interface: NXaperture
describe any additional information in a note*

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








getNote
public NXnote getNote(java.lang.String name)
Description copied from interface: NXaperture
Get a NXnote node by name:
 
 
 describe any additional information in a note*
 

Specified by:
getNote in interface NXaperture
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: NXaperture
Set a NXnote node by name:
 
 
 describe any additional information in a note*
 

Specified by:
setNote in interface NXaperture
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: NXaperture
Get all NXnote nodes:
 
 
 describe any additional information in a note*
 

Specified by:
getAllNote in interface NXaperture
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: NXaperture
Set multiple child nodes of a particular type.
 
 
 describe any additional information in a note*
 

Specified by:
setAllNote in interface NXaperture
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

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
`NexusBaseClass`	`getNexusBaseClass()` Enum constant from `NexusBaseClass` for this base class, e.g.
`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*
`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.
`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*

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