generated.docs.javadoc.org.eclipse.dawnsci.nexus.builder.data.impl.AxisFieldModel.html Maven / Gradle / Ivy






AxisFieldModel (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.builder.data.impl
Class AxisFieldModel



java.lang.Object


org.eclipse.dawnsci.nexus.builder.data.impl.DataFieldModel


org.eclipse.dawnsci.nexus.builder.data.impl.AxisFieldModel











public class AxisFieldModel
extends DataFieldModel
A model for how the dimensions of a data field correspond to the dimensions
 of the primary data field (i.e. the @signal field ) of an NXdata group.











Constructor Summary

Constructors 

Constructor and Description


AxisFieldModel(java.lang.String sourceFieldName,
              int fieldRank) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


protected void
appendMemberFields(java.lang.StringBuilder sb) 


java.lang.Integer
getDefaultAxisDimension() 


int[]
getDimensionMappings() 


void
setDefaultAxisDimension(java.lang.Integer defaultAxisDimension)
Sets the default axis dimension for this data field to the given value.



void
setDimensionMappings(int... dimensionMappings)
Sets the dimension mappings for the given field to the given value.







Methods inherited from class org.eclipse.dawnsci.nexus.builder.data.impl.DataFieldModel
getDestinationFieldName, getFieldRank, getSourceFieldName, setDestinationFieldName, toString





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait














Constructor Detail





AxisFieldModel
public AxisFieldModel(java.lang.String sourceFieldName,
                      int fieldRank)









Method Detail





setDefaultAxisDimension
public void setDefaultAxisDimension(java.lang.Integer defaultAxisDimension)
Sets the default axis dimension for this data field to the given value.
 This is the dimension of the default data field of the NXdata group
 for which this field provides a default axis when plotting the data.

Parameters:
defaultAxisDimension - default axis dimension index








getDefaultAxisDimension
public java.lang.Integer getDefaultAxisDimension()







setDimensionMappings
public void setDimensionMappings(int... dimensionMappings)
Sets the dimension mappings for the given field to the given value.
 This is the mapping from the dimensions of this field to the dimensions
 of the default data field of the NXdata group.

Parameters:
dimensionMappings - dimension mappings








getDimensionMappings
public int[] getDimensionMappings()







appendMemberFields
protected void appendMemberFields(java.lang.StringBuilder sb)

Overrides:
appendMemberFields in class DataFieldModel














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
`protected void`	`appendMemberFields(java.lang.StringBuilder sb)`
`java.lang.Integer`	`getDefaultAxisDimension()`
`int[]`	`getDimensionMappings()`
`void`	`setDefaultAxisDimension(java.lang.Integer defaultAxisDimension)` Sets the default axis dimension for this data field to the given value.
`void`	`setDimensionMappings(int... dimensionMappings)` Sets the dimension mappings for the given field to the given value.