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






NXshape (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
Interface NXshape






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


All Known Implementing Classes:
NXshapeImpl




public interface NXshape
extends NXobject
legacy class - (used by :ref:`NXgeometry`) - the shape and size of a component.
 This is the description of the general shape and size of a
 component, which may be made up of ``numobj`` separate
 elements - it is used by the :ref:`NXgeometry` class











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DIRECTION 


static java.lang.String
NX_SHAPE 


static java.lang.String
NX_SIZE 






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


IDataset
getDirection()


java.lang.String
getDirectionScalar()


IDataset
getShape()
general shape of a component



java.lang.String
getShapeScalar()
general shape of a component



IDataset
getSize()
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).



java.lang.Double
getSizeScalar()
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).



DataNode
setDirection(IDataset direction)


DataNode
setDirectionScalar(java.lang.String direction)


DataNode
setShape(IDataset shape)
general shape of a component



DataNode
setShapeScalar(java.lang.String shape)
general shape of a component



DataNode
setSize(IDataset size)
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).



DataNode
setSizeScalar(java.lang.Double size)
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).







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_SHAPE
static final java.lang.String NX_SHAPE

See Also:
Constant Field Values








NX_SIZE
static final java.lang.String NX_SIZE

See Also:
Constant Field Values








NX_DIRECTION
static final java.lang.String NX_DIRECTION

See Also:
Constant Field Values










Method Detail





getShape
IDataset getShape()
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Returns:
the value.








setShape
DataNode setShape(IDataset shape)
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Parameters:
shape - the shape








getShapeScalar
java.lang.String getShapeScalar()
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Returns:
the value.








setShapeScalar
DataNode setShapeScalar(java.lang.String shape)
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Parameters:
shape - the shape








getSize
IDataset getSize()
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).
 The meaning and location of these axes will vary according to the value
 of the "shape" variable.
 ``nshapepar`` defines how many parameters:
 - For "nxcylinder" type the parameters are (diameter,height) and a three value orientation vector of the cylinder.
 - For the "nxbox" type the parameters are (length,width,height).
 - For the "nxsphere" type the parameters are (diameter).
 - For nxcone cone half aperture
 - For nxelliptical, semi-major axis, semi-minor-axis, angle of major axis and pole
 - For nxtoroidal, major radius, minor radius
 - For nxparabolic, parabolic parameter a
 - For nxpolynomial, an array of polynom coefficients, the dimension of the array
 encodes the degree of the polynom
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: nshapepar;
 

Returns:
the value.








setSize
DataNode setSize(IDataset size)
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).
 The meaning and location of these axes will vary according to the value
 of the "shape" variable.
 ``nshapepar`` defines how many parameters:
 - For "nxcylinder" type the parameters are (diameter,height) and a three value orientation vector of the cylinder.
 - For the "nxbox" type the parameters are (length,width,height).
 - For the "nxsphere" type the parameters are (diameter).
 - For nxcone cone half aperture
 - For nxelliptical, semi-major axis, semi-minor-axis, angle of major axis and pole
 - For nxtoroidal, major radius, minor radius
 - For nxparabolic, parabolic parameter a
 - For nxpolynomial, an array of polynom coefficients, the dimension of the array
 encodes the degree of the polynom
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: nshapepar;
 

Parameters:
size - the size








getSizeScalar
java.lang.Double getSizeScalar()
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).
 The meaning and location of these axes will vary according to the value
 of the "shape" variable.
 ``nshapepar`` defines how many parameters:
 - For "nxcylinder" type the parameters are (diameter,height) and a three value orientation vector of the cylinder.
 - For the "nxbox" type the parameters are (length,width,height).
 - For the "nxsphere" type the parameters are (diameter).
 - For nxcone cone half aperture
 - For nxelliptical, semi-major axis, semi-minor-axis, angle of major axis and pole
 - For nxtoroidal, major radius, minor radius
 - For nxparabolic, parabolic parameter a
 - For nxpolynomial, an array of polynom coefficients, the dimension of the array
 encodes the degree of the polynom
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: nshapepar;
 

Returns:
the value.








setSizeScalar
DataNode setSizeScalar(java.lang.Double size)
physical extent of the object along its local axes (after NXorientation)
 with the center of mass at the local origin (after NXtranslation).
 The meaning and location of these axes will vary according to the value
 of the "shape" variable.
 ``nshapepar`` defines how many parameters:
 - For "nxcylinder" type the parameters are (diameter,height) and a three value orientation vector of the cylinder.
 - For the "nxbox" type the parameters are (length,width,height).
 - For the "nxsphere" type the parameters are (diameter).
 - For nxcone cone half aperture
 - For nxelliptical, semi-major axis, semi-minor-axis, angle of major axis and pole
 - For nxtoroidal, major radius, minor radius
 - For nxparabolic, parabolic parameter a
 - For nxpolynomial, an array of polynom coefficients, the dimension of the array
 encodes the degree of the polynom
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: numobj; 2: nshapepar;
 

Parameters:
size - the size








getDirection
IDataset getDirection()

 
Enumeration:

 concave 
 convex 

 

Returns:
the value.








setDirection
DataNode setDirection(IDataset direction)

 
Enumeration:

 concave 
 convex 

 

Parameters:
direction - the direction








getDirectionScalar
java.lang.String getDirectionScalar()

 
Enumeration:

 concave 
 convex 

 

Returns:
the value.








setDirectionScalar
DataNode setDirectionScalar(java.lang.String direction)

 
Enumeration:

 concave 
 convex 

 

Parameters:
direction - the direction














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	Field and Description
`static java.lang.String`	`NX_DIRECTION`
`static java.lang.String`	`NX_SHAPE`
`static java.lang.String`	`NX_SIZE`

Modifier and Type	Method and Description
`IDataset`	`getDirection()`
`java.lang.String`	`getDirectionScalar()`
`IDataset`	`getShape()` general shape of a component
`java.lang.String`	`getShapeScalar()` general shape of a component
`IDataset`	`getSize()` physical extent of the object along its local axes (after NXorientation) with the center of mass at the local origin (after NXtranslation).
`java.lang.Double`	`getSizeScalar()` physical extent of the object along its local axes (after NXorientation) with the center of mass at the local origin (after NXtranslation).
`DataNode`	`setDirection(IDataset direction)`
`DataNode`	`setDirectionScalar(java.lang.String direction)`
`DataNode`	`setShape(IDataset shape)` general shape of a component
`DataNode`	`setShapeScalar(java.lang.String shape)` general shape of a component
`DataNode`	`setSize(IDataset size)` physical extent of the object along its local axes (after NXorientation) with the center of mass at the local origin (after NXtranslation).
`DataNode`	`setSizeScalar(java.lang.Double size)` physical extent of the object along its local axes (after NXorientation) with the center of mass at the local origin (after NXtranslation).