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






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



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













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




public class NXshapeImpl
extends NXobjectImpl
implements NXshape
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

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.NXshape
NX_DIRECTION, NX_SHAPE, NX_SIZE





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








Constructor Summary

Constructors 

Constructor and Description


NXshapeImpl() 


NXshapeImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getDirection()


java.lang.String
getDirectionScalar()


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



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.



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





NXshapeImpl
public NXshapeImpl()







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








getShape
public IDataset getShape()
Description copied from interface: NXshape
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Specified by:
getShape in interface NXshape
Returns:
the value.








getShapeScalar
public java.lang.String getShapeScalar()
Description copied from interface: NXshape
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Specified by:
getShapeScalar in interface NXshape
Returns:
the value.








setShape
public DataNode setShape(IDataset shape)
Description copied from interface: NXshape
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Specified by:
setShape in interface NXshape
Parameters:
shape - the shape








setShapeScalar
public DataNode setShapeScalar(java.lang.String shape)
Description copied from interface: NXshape
general shape of a component
 
 
Enumeration:

 nxflat 
 nxcylinder 
 nxbox 
 nxsphere 
 nxcone 
 nxelliptical 
 nxtoroidal 
 nxparabolic 
 nxpolynomial 

 

Specified by:
setShapeScalar in interface NXshape
Parameters:
shape - the shape








getSize
public IDataset getSize()
Description copied from interface: NXshape
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;
 

Specified by:
getSize in interface NXshape
Returns:
the value.








getSizeScalar
public java.lang.Double getSizeScalar()
Description copied from interface: NXshape
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;
 

Specified by:
getSizeScalar in interface NXshape
Returns:
the value.








setSize
public DataNode setSize(IDataset size)
Description copied from interface: NXshape
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;
 

Specified by:
setSize in interface NXshape
Parameters:
size - the size








setSizeScalar
public DataNode setSizeScalar(java.lang.Double size)
Description copied from interface: NXshape
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;
 

Specified by:
setSizeScalar in interface NXshape
Parameters:
size - the size








getDirection
public IDataset getDirection()
Description copied from interface: NXshape

 
Enumeration:

 concave 
 convex 

 

Specified by:
getDirection in interface NXshape
Returns:
the value.








getDirectionScalar
public java.lang.String getDirectionScalar()
Description copied from interface: NXshape

 
Enumeration:

 concave 
 convex 

 

Specified by:
getDirectionScalar in interface NXshape
Returns:
the value.








setDirection
public DataNode setDirection(IDataset direction)
Description copied from interface: NXshape

 
Enumeration:

 concave 
 convex 

 

Specified by:
setDirection in interface NXshape
Parameters:
direction - the direction








setDirectionScalar
public DataNode setDirectionScalar(java.lang.String direction)
Description copied from interface: NXshape

 
Enumeration:

 concave 
 convex 

 

Specified by:
setDirectionScalar in interface NXshape
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	Method and Description
`IDataset`	`getDirection()`
`java.lang.String`	`getDirectionScalar()`
`NexusBaseClass`	`getNexusBaseClass()` Enum constant from `NexusBaseClass` for this base class, e.g.
`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.
`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).

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