All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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






NXdisk_chopperImpl (h5jan API)












org.eclipse.dawnsci.nexus.impl

Class NXdisk_chopperImpl

    • Field Detail

      • PERMITTED_CHILD_GROUP_CLASSES

        public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES
    • Constructor Detail

      • NXdisk_chopperImpl

        public NXdisk_chopperImpl()
      • NXdisk_chopperImpl

        public NXdisk_chopperImpl(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
      • getType

        public IDataset getType()
        Description copied from interface: NXdisk_chopper
        Type of the disk-chopper: only one from the enumerated list (match text exactly)

        Enumeration:

        • Chopper type single
        • contra_rotating_pair
        • synchro_pair

        Specified by:
        getType in interface NXdisk_chopper
        Returns:
        the value.
      • getTypeScalar

        public java.lang.String getTypeScalar()
        Description copied from interface: NXdisk_chopper
        Type of the disk-chopper: only one from the enumerated list (match text exactly)

        Enumeration:

        • Chopper type single
        • contra_rotating_pair
        • synchro_pair

        Specified by:
        getTypeScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setType

        public DataNode setType(IDataset type)
        Description copied from interface: NXdisk_chopper
        Type of the disk-chopper: only one from the enumerated list (match text exactly)

        Enumeration:

        • Chopper type single
        • contra_rotating_pair
        • synchro_pair

        Specified by:
        setType in interface NXdisk_chopper
        Parameters:
        type - the type
      • setTypeScalar

        public DataNode setTypeScalar(java.lang.String type)
        Description copied from interface: NXdisk_chopper
        Type of the disk-chopper: only one from the enumerated list (match text exactly)

        Enumeration:

        • Chopper type single
        • contra_rotating_pair
        • synchro_pair

        Specified by:
        setTypeScalar in interface NXdisk_chopper
        Parameters:
        type - the type
      • getRotation_speed

        public IDataset getRotation_speed()
        Description copied from interface: NXdisk_chopper
        chopper rotation speed

        Type: NX_FLOAT Units: NX_FREQUENCY

        Specified by:
        getRotation_speed in interface NXdisk_chopper
        Returns:
        the value.
      • getRotation_speedScalar

        public java.lang.Double getRotation_speedScalar()
        Description copied from interface: NXdisk_chopper
        chopper rotation speed

        Type: NX_FLOAT Units: NX_FREQUENCY

        Specified by:
        getRotation_speedScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setRotation_speed

        public DataNode setRotation_speed(IDataset rotation_speed)
        Description copied from interface: NXdisk_chopper
        chopper rotation speed

        Type: NX_FLOAT Units: NX_FREQUENCY

        Specified by:
        setRotation_speed in interface NXdisk_chopper
        Parameters:
        rotation_speed - the rotation_speed
      • setRotation_speedScalar

        public DataNode setRotation_speedScalar(java.lang.Double rotation_speed)
        Description copied from interface: NXdisk_chopper
        chopper rotation speed

        Type: NX_FLOAT Units: NX_FREQUENCY

        Specified by:
        setRotation_speedScalar in interface NXdisk_chopper
        Parameters:
        rotation_speed - the rotation_speed
      • getSlits

        public IDataset getSlits()
        Description copied from interface: NXdisk_chopper
        Number of slits

        Type: NX_INT

        Specified by:
        getSlits in interface NXdisk_chopper
        Returns:
        the value.
      • getSlitsScalar

        public java.lang.Long getSlitsScalar()
        Description copied from interface: NXdisk_chopper
        Number of slits

        Type: NX_INT

        Specified by:
        getSlitsScalar in interface NXdisk_chopper
        Returns:
        the value.
      • getSlit_angle

        public IDataset getSlit_angle()
        Description copied from interface: NXdisk_chopper
        angular opening

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        getSlit_angle in interface NXdisk_chopper
        Returns:
        the value.
      • getSlit_angleScalar

        public java.lang.Double getSlit_angleScalar()
        Description copied from interface: NXdisk_chopper
        angular opening

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        getSlit_angleScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setSlit_angle

        public DataNode setSlit_angle(IDataset slit_angle)
        Description copied from interface: NXdisk_chopper
        angular opening

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        setSlit_angle in interface NXdisk_chopper
        Parameters:
        slit_angle - the slit_angle
      • setSlit_angleScalar

        public DataNode setSlit_angleScalar(java.lang.Double slit_angle)
        Description copied from interface: NXdisk_chopper
        angular opening

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        setSlit_angleScalar in interface NXdisk_chopper
        Parameters:
        slit_angle - the slit_angle
      • getPair_separation

        public IDataset getPair_separation()
        Description copied from interface: NXdisk_chopper
        disc spacing in direction of beam

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getPair_separation in interface NXdisk_chopper
        Returns:
        the value.
      • getPair_separationScalar

        public java.lang.Double getPair_separationScalar()
        Description copied from interface: NXdisk_chopper
        disc spacing in direction of beam

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getPair_separationScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setPair_separation

        public DataNode setPair_separation(IDataset pair_separation)
        Description copied from interface: NXdisk_chopper
        disc spacing in direction of beam

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setPair_separation in interface NXdisk_chopper
        Parameters:
        pair_separation - the pair_separation
      • setPair_separationScalar

        public DataNode setPair_separationScalar(java.lang.Double pair_separation)
        Description copied from interface: NXdisk_chopper
        disc spacing in direction of beam

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setPair_separationScalar in interface NXdisk_chopper
        Parameters:
        pair_separation - the pair_separation
      • getRadius

        public IDataset getRadius()
        Description copied from interface: NXdisk_chopper
        radius to centre of slit

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getRadius in interface NXdisk_chopper
        Returns:
        the value.
      • getRadiusScalar

        public java.lang.Double getRadiusScalar()
        Description copied from interface: NXdisk_chopper
        radius to centre of slit

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getRadiusScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setRadius

        public DataNode setRadius(IDataset radius)
        Description copied from interface: NXdisk_chopper
        radius to centre of slit

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setRadius in interface NXdisk_chopper
        Parameters:
        radius - the radius
      • setRadiusScalar

        public DataNode setRadiusScalar(java.lang.Double radius)
        Description copied from interface: NXdisk_chopper
        radius to centre of slit

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setRadiusScalar in interface NXdisk_chopper
        Parameters:
        radius - the radius
      • getSlit_height

        public IDataset getSlit_height()
        Description copied from interface: NXdisk_chopper
        total slit height

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getSlit_height in interface NXdisk_chopper
        Returns:
        the value.
      • getSlit_heightScalar

        public java.lang.Double getSlit_heightScalar()
        Description copied from interface: NXdisk_chopper
        total slit height

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getSlit_heightScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setSlit_height

        public DataNode setSlit_height(IDataset slit_height)
        Description copied from interface: NXdisk_chopper
        total slit height

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setSlit_height in interface NXdisk_chopper
        Parameters:
        slit_height - the slit_height
      • setSlit_heightScalar

        public DataNode setSlit_heightScalar(java.lang.Double slit_height)
        Description copied from interface: NXdisk_chopper
        total slit height

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setSlit_heightScalar in interface NXdisk_chopper
        Parameters:
        slit_height - the slit_height
      • getPhase

        public IDataset getPhase()
        Description copied from interface: NXdisk_chopper
        chopper phase angle

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        getPhase in interface NXdisk_chopper
        Returns:
        the value.
      • getPhaseScalar

        public java.lang.Double getPhaseScalar()
        Description copied from interface: NXdisk_chopper
        chopper phase angle

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        getPhaseScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setPhase

        public DataNode setPhase(IDataset phase)
        Description copied from interface: NXdisk_chopper
        chopper phase angle

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        setPhase in interface NXdisk_chopper
        Parameters:
        phase - the phase
      • setPhaseScalar

        public DataNode setPhaseScalar(java.lang.Double phase)
        Description copied from interface: NXdisk_chopper
        chopper phase angle

        Type: NX_FLOAT Units: NX_ANGLE

        Specified by:
        setPhaseScalar in interface NXdisk_chopper
        Parameters:
        phase - the phase
      • getRatio

        public IDataset getRatio()
        Description copied from interface: NXdisk_chopper
        pulse reduction factor of this chopper in relation to other choppers/fastest pulse in the instrument

        Type: NX_INT

        Specified by:
        getRatio in interface NXdisk_chopper
        Returns:
        the value.
      • getRatioScalar

        public java.lang.Long getRatioScalar()
        Description copied from interface: NXdisk_chopper
        pulse reduction factor of this chopper in relation to other choppers/fastest pulse in the instrument

        Type: NX_INT

        Specified by:
        getRatioScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setRatio

        public DataNode setRatio(IDataset ratio)
        Description copied from interface: NXdisk_chopper
        pulse reduction factor of this chopper in relation to other choppers/fastest pulse in the instrument

        Type: NX_INT

        Specified by:
        setRatio in interface NXdisk_chopper
        Parameters:
        ratio - the ratio
      • setRatioScalar

        public DataNode setRatioScalar(java.lang.Long ratio)
        Description copied from interface: NXdisk_chopper
        pulse reduction factor of this chopper in relation to other choppers/fastest pulse in the instrument

        Type: NX_INT

        Specified by:
        setRatioScalar in interface NXdisk_chopper
        Parameters:
        ratio - the ratio
      • getDistance

        public IDataset getDistance()
        Description copied from interface: NXdisk_chopper
        Effective distance to the origin

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getDistance in interface NXdisk_chopper
        Returns:
        the value.
      • getDistanceScalar

        public java.lang.Double getDistanceScalar()
        Description copied from interface: NXdisk_chopper
        Effective distance to the origin

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        getDistanceScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setDistance

        public DataNode setDistance(IDataset distance)
        Description copied from interface: NXdisk_chopper
        Effective distance to the origin

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setDistance in interface NXdisk_chopper
        Parameters:
        distance - the distance
      • setDistanceScalar

        public DataNode setDistanceScalar(java.lang.Double distance)
        Description copied from interface: NXdisk_chopper
        Effective distance to the origin

        Type: NX_FLOAT Units: NX_LENGTH

        Specified by:
        setDistanceScalar in interface NXdisk_chopper
        Parameters:
        distance - the distance
      • getWavelength_range

        public IDataset getWavelength_range()
        Description copied from interface: NXdisk_chopper
        low and high values of wavelength range transmitted

        Type: NX_FLOAT Units: NX_WAVELENGTH Dimensions: 1: 2;

        Specified by:
        getWavelength_range in interface NXdisk_chopper
        Returns:
        the value.
      • getWavelength_rangeScalar

        public java.lang.Double getWavelength_rangeScalar()
        Description copied from interface: NXdisk_chopper
        low and high values of wavelength range transmitted

        Type: NX_FLOAT Units: NX_WAVELENGTH Dimensions: 1: 2;

        Specified by:
        getWavelength_rangeScalar in interface NXdisk_chopper
        Returns:
        the value.
      • setWavelength_range

        public DataNode setWavelength_range(IDataset wavelength_range)
        Description copied from interface: NXdisk_chopper
        low and high values of wavelength range transmitted

        Type: NX_FLOAT Units: NX_WAVELENGTH Dimensions: 1: 2;

        Specified by:
        setWavelength_range in interface NXdisk_chopper
        Parameters:
        wavelength_range - the wavelength_range
      • setWavelength_rangeScalar

        public DataNode setWavelength_rangeScalar(java.lang.Double wavelength_range)
        Description copied from interface: NXdisk_chopper
        low and high values of wavelength range transmitted

        Type: NX_FLOAT Units: NX_WAVELENGTH Dimensions: 1: 2;

        Specified by:
        setWavelength_rangeScalar in interface NXdisk_chopper
        Parameters:
        wavelength_range - the wavelength_range
      • getGeometry

        public NXgeometry getGeometry(java.lang.String name)
        Description copied from interface: NXdisk_chopper
        Get a NXgeometry node by name:
        Specified by:
        getGeometry in interface NXdisk_chopper
        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: NXdisk_chopper
        Set a NXgeometry node by name:
        Specified by:
        setGeometry in interface NXdisk_chopper
        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: NXdisk_chopper
        Get all NXgeometry nodes:
        Specified by:
        getAllGeometry in interface NXdisk_chopper
        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: NXdisk_chopper
        Set multiple child nodes of a particular type.
        Specified by:
        setAllGeometry in interface NXdisk_chopper
        Parameters:
        geometry - the child nodes to add




© 2015 - 2024 Weber Informatics LLC | Privacy Policy