• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• DataDevice.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.builder.data.DataDevice.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.builder.data
Interface DataDevice<N extends NXobject>






Type Parameters:
N - the sub-interface of NXobject that the nexus object was created from


All Known Subinterfaces:
AxisDataDevice<N>, PrimaryDataDevice<N>


All Known Implementing Classes:
AxisDataDeviceImpl, DataDeviceImpl, PrimaryDataDeviceImpl




public interface DataDevice<N extends NXobject>
Represents a device which can be added to an NexusDataBuilder to build an
 NXdata group. It may wrap on otherwise be constructed from an instance of a
 sub-interface of NXobject. The method getFieldNode(String) should return
 the node with the given name from the.
 

 This is an abstract interface. Any class which implements this interface should also implement
 either PrimaryDataDevice (which sh











Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


java.util.List<java.lang.String>
getAxisFieldNames()
Returns the list of the axis field names.



java.lang.Integer
getDefaultAxisDimension(java.lang.String sourceFieldName)
Returns the index of the dimension of the @signal field of the NXdata
 group the field of the NXobject with the given name is a default axis for, or
 null if this field is not a default axis of the @signal field.



java.lang.String
getDestinationFieldName(java.lang.String sourceFieldName)
Returns the name that the field with the given name in the NXobject should be
 given in the NXdata group when added (i.e.



int[]
getDimensionMappings(java.lang.String sourceFieldName)
Returns the dimension mappings for the field with the given name.



Node
getFieldNode(java.lang.String sourceFieldName)
Returns the Node for the field with the given name in the NXobject
 that this object was created from.



int
getFieldRank(java.lang.String sourceFieldName)
Returns the rank of the source field with the given name



N
getNexusObject()
Returns the nexus object for this data device.



boolean
isPrimary()
Returns whether this is the primary device for the NXdata group being built.
















Method Detail





isPrimary
boolean isPrimary()
Returns whether this is the primary device for the NXdata group being built.
 This primary device is the device which contains the @signal field for
 the NXdata group.

Returns:
true if this is the primary device, false otherwise








getNexusObject
N getNexusObject()
Returns the nexus object for this data device.

Returns:
nexus object








getAxisFieldNames
java.util.List<java.lang.String> getAxisFieldNames()
Returns the list of the axis field names.

Returns:
axis field names








getFieldNode
Node getFieldNode(java.lang.String sourceFieldName)
Returns the Node for the field with the given name in the NXobject
 that this object was created from. In most cases this will be
 a DataNode, but may be a SymbolicNode in the case of an external link

Parameters:
sourceFieldName - field name in the existing NXobject
Returns:
the node with the given name








getFieldRank
int getFieldRank(java.lang.String sourceFieldName)
Returns the rank of the source field with the given name

Parameters:
sourceFieldName - field name in the existing NXobject
Returns:
rank of the field with the given name








getDestinationFieldName
java.lang.String getDestinationFieldName(java.lang.String sourceFieldName)
Returns the name that the field with the given name in the NXobject should be
 given in the NXdata group when added (i.e. linked to).

Parameters:
sourceFieldName - field name in the existing NXobject
Returns:
destination name








getDimensionMappings
int[] getDimensionMappings(java.lang.String sourceFieldName)
Returns the dimension mappings for the field with the given name. This is an array of
 integers each of which specifies the index of the @signal field that
 the dimension of the dataset for this field name with the corresponding index maps to.

Parameters:
sourceFieldName - field name in the existing NXobject
Returns:
dimension mappings between the field with the given name and the 
    @signal field of the NXdata group








getDefaultAxisDimension
java.lang.Integer getDefaultAxisDimension(java.lang.String sourceFieldName)
Returns the index of the dimension of the @signal field of the NXdata
 group the field of the NXobject with the given name is a default axis for, or
 null if this field is not a default axis of the @signal field.

Parameters:
sourceFieldName - field name in the existing NXobject
Returns:
dimension of the signal field that this field is a default axis for,
    or null














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