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

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






NXmirror (h5jan API)












org.eclipse.dawnsci.nexus

Interface NXmirror

    • Method Detail

      • getGeometry

        NXgeometry getGeometry()
        Returns:
        the value.
      • setGeometry

        void setGeometry(NXgeometry geometry)
        Parameters:
        geometry - the geometry
      • getGeometry

        NXgeometry getGeometry(java.lang.String name)
        Get a NXgeometry node by name:
        Parameters:
        name - the name of the node.
        Returns:
        a map from node names to the NXgeometry for that node.
      • setGeometry

        void setGeometry(java.lang.String name,
                         NXgeometry geometry)
        Set a NXgeometry node by name:
        Parameters:
        name - the name of the node
        geometry - the value to set
      • getAllGeometry

        java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
        Get all NXgeometry nodes:
        Returns:
        a map from node names to the NXgeometry for that node.
      • setAllGeometry

        void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
        Set multiple child nodes of a particular type.
        Parameters:
        geometry - the child nodes to add
      • getType

        IDataset getType()

        Enumeration:

        • single mirror with a single material as a reflecting surface
        • multi mirror with stacked, multiple layers as a reflecting surface

        Returns:
        the value.
      • setType

        DataNode setType(IDataset type)

        Enumeration:

        • single mirror with a single material as a reflecting surface
        • multi mirror with stacked, multiple layers as a reflecting surface

        Parameters:
        type - the type
      • getTypeScalar

        java.lang.String getTypeScalar()

        Enumeration:

        • single mirror with a single material as a reflecting surface
        • multi mirror with stacked, multiple layers as a reflecting surface

        Returns:
        the value.
      • setTypeScalar

        DataNode setTypeScalar(java.lang.String type)

        Enumeration:

        • single mirror with a single material as a reflecting surface
        • multi mirror with stacked, multiple layers as a reflecting surface

        Parameters:
        type - the type
      • getDescription

        IDataset getDescription()
        description of this mirror
        Returns:
        the value.
      • setDescription

        DataNode setDescription(IDataset description)
        description of this mirror
        Parameters:
        description - the description
      • getDescriptionScalar

        java.lang.String getDescriptionScalar()
        description of this mirror
        Returns:
        the value.
      • setDescriptionScalar

        DataNode setDescriptionScalar(java.lang.String description)
        description of this mirror
        Parameters:
        description - the description
      • getIncident_angle

        IDataset getIncident_angle()

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setIncident_angle

        DataNode setIncident_angle(IDataset incident_angle)

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        incident_angle - the incident_angle
      • getIncident_angleScalar

        java.lang.Double getIncident_angleScalar()

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setIncident_angleScalar

        DataNode setIncident_angleScalar(java.lang.Double incident_angle)

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        incident_angle - the incident_angle
      • getReflectivity

        NXdata getReflectivity()
        Reflectivity as function of wavelength
        Returns:
        the value.
      • setReflectivity

        void setReflectivity(NXdata reflectivity)
        Reflectivity as function of wavelength
        Parameters:
        reflectivity - the reflectivity
      • getBend_angle_x

        IDataset getBend_angle_x()

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setBend_angle_x

        DataNode setBend_angle_x(IDataset bend_angle_x)

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        bend_angle_x - the bend_angle_x
      • getBend_angle_xScalar

        java.lang.Double getBend_angle_xScalar()

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setBend_angle_xScalar

        DataNode setBend_angle_xScalar(java.lang.Double bend_angle_x)

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        bend_angle_x - the bend_angle_x
      • getBend_angle_y

        IDataset getBend_angle_y()

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setBend_angle_y

        DataNode setBend_angle_y(IDataset bend_angle_y)

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        bend_angle_y - the bend_angle_y
      • getBend_angle_yScalar

        java.lang.Double getBend_angle_yScalar()

        Type: NX_FLOAT Units: NX_ANGLE

        Returns:
        the value.
      • setBend_angle_yScalar

        DataNode setBend_angle_yScalar(java.lang.Double bend_angle_y)

        Type: NX_FLOAT Units: NX_ANGLE

        Parameters:
        bend_angle_y - the bend_angle_y
      • getInterior_atmosphere

        IDataset getInterior_atmosphere()

        Enumeration:

        • vacuum
        • helium
        • argon

        Returns:
        the value.
      • setInterior_atmosphere

        DataNode setInterior_atmosphere(IDataset interior_atmosphere)

        Enumeration:

        • vacuum
        • helium
        • argon

        Parameters:
        interior_atmosphere - the interior_atmosphere
      • getInterior_atmosphereScalar

        java.lang.String getInterior_atmosphereScalar()

        Enumeration:

        • vacuum
        • helium
        • argon

        Returns:
        the value.
      • setInterior_atmosphereScalar

        DataNode setInterior_atmosphereScalar(java.lang.String interior_atmosphere)

        Enumeration:

        • vacuum
        • helium
        • argon

        Parameters:
        interior_atmosphere - the interior_atmosphere
      • getExternal_material

        IDataset getExternal_material()
        external material outside substrate
        Returns:
        the value.
      • setExternal_material

        DataNode setExternal_material(IDataset external_material)
        external material outside substrate
        Parameters:
        external_material - the external_material
      • getExternal_materialScalar

        java.lang.String getExternal_materialScalar()
        external material outside substrate
        Returns:
        the value.
      • setExternal_materialScalar

        DataNode setExternal_materialScalar(java.lang.String external_material)
        external material outside substrate
        Parameters:
        external_material - the external_material
      • getM_value

        IDataset getM_value()
        The m value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.

        Type: NX_FLOAT Units: NX_UNITLESS

        Returns:
        the value.
      • setM_value

        DataNode setM_value(IDataset m_value)
        The m value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.

        Type: NX_FLOAT Units: NX_UNITLESS

        Parameters:
        m_value - the m_value
      • getM_valueScalar

        java.lang.Double getM_valueScalar()
        The m value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.

        Type: NX_FLOAT Units: NX_UNITLESS

        Returns:
        the value.
      • setM_valueScalar

        DataNode setM_valueScalar(java.lang.Double m_value)
        The m value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.

        Type: NX_FLOAT Units: NX_UNITLESS

        Parameters:
        m_value - the m_value
      • getSubstrate_material

        IDataset getSubstrate_material()
        Returns:
        the value.
      • setSubstrate_material

        DataNode setSubstrate_material(IDataset substrate_material)
        Parameters:
        substrate_material - the substrate_material
      • getSubstrate_materialScalar

        java.lang.String getSubstrate_materialScalar()
        Returns:
        the value.
      • setSubstrate_materialScalar

        DataNode setSubstrate_materialScalar(java.lang.String substrate_material)
        Parameters:
        substrate_material - the substrate_material
      • getSubstrate_density

        IDataset getSubstrate_density()

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setSubstrate_density

        DataNode setSubstrate_density(IDataset substrate_density)

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        substrate_density - the substrate_density
      • getSubstrate_densityScalar

        java.lang.Double getSubstrate_densityScalar()

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setSubstrate_densityScalar

        DataNode setSubstrate_densityScalar(java.lang.Double substrate_density)

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        substrate_density - the substrate_density
      • getSubstrate_thickness

        IDataset getSubstrate_thickness()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_thickness

        DataNode setSubstrate_thickness(IDataset substrate_thickness)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_thickness - the substrate_thickness
      • getSubstrate_thicknessScalar

        java.lang.Double getSubstrate_thicknessScalar()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_thicknessScalar

        DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_thickness - the substrate_thickness
      • getCoating_material

        IDataset getCoating_material()
        Returns:
        the value.
      • setCoating_material

        DataNode setCoating_material(IDataset coating_material)
        Parameters:
        coating_material - the coating_material
      • getCoating_materialScalar

        java.lang.String getCoating_materialScalar()
        Returns:
        the value.
      • setCoating_materialScalar

        DataNode setCoating_materialScalar(java.lang.String coating_material)
        Parameters:
        coating_material - the coating_material
      • getSubstrate_roughness

        IDataset getSubstrate_roughness()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_roughness

        DataNode setSubstrate_roughness(IDataset substrate_roughness)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_roughness - the substrate_roughness
      • getSubstrate_roughnessScalar

        java.lang.Double getSubstrate_roughnessScalar()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setSubstrate_roughnessScalar

        DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        substrate_roughness - the substrate_roughness
      • getCoating_roughness

        IDataset getCoating_roughness()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setCoating_roughness

        DataNode setCoating_roughness(IDataset coating_roughness)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        coating_roughness - the coating_roughness
      • getCoating_roughnessScalar

        java.lang.Double getCoating_roughnessScalar()

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setCoating_roughnessScalar

        DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        coating_roughness - the coating_roughness
      • getEven_layer_material

        IDataset getEven_layer_material()
        Returns:
        the value.
      • setEven_layer_material

        DataNode setEven_layer_material(IDataset even_layer_material)
        Parameters:
        even_layer_material - the even_layer_material
      • getEven_layer_materialScalar

        java.lang.String getEven_layer_materialScalar()
        Returns:
        the value.
      • setEven_layer_materialScalar

        DataNode setEven_layer_materialScalar(java.lang.String even_layer_material)
        Parameters:
        even_layer_material - the even_layer_material
      • getEven_layer_density

        IDataset getEven_layer_density()

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setEven_layer_density

        DataNode setEven_layer_density(IDataset even_layer_density)

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        even_layer_density - the even_layer_density
      • getEven_layer_densityScalar

        java.lang.Double getEven_layer_densityScalar()

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setEven_layer_densityScalar

        DataNode setEven_layer_densityScalar(java.lang.Double even_layer_density)

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        even_layer_density - the even_layer_density
      • getOdd_layer_material

        IDataset getOdd_layer_material()
        Returns:
        the value.
      • setOdd_layer_material

        DataNode setOdd_layer_material(IDataset odd_layer_material)
        Parameters:
        odd_layer_material - the odd_layer_material
      • getOdd_layer_materialScalar

        java.lang.String getOdd_layer_materialScalar()
        Returns:
        the value.
      • setOdd_layer_materialScalar

        DataNode setOdd_layer_materialScalar(java.lang.String odd_layer_material)
        Parameters:
        odd_layer_material - the odd_layer_material
      • getOdd_layer_density

        IDataset getOdd_layer_density()

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setOdd_layer_density

        DataNode setOdd_layer_density(IDataset odd_layer_density)

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        odd_layer_density - the odd_layer_density
      • getOdd_layer_densityScalar

        java.lang.Double getOdd_layer_densityScalar()

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setOdd_layer_densityScalar

        DataNode setOdd_layer_densityScalar(java.lang.Double odd_layer_density)

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        odd_layer_density - the odd_layer_density
      • getLayer_thickness

        IDataset getLayer_thickness()
        An array describing the thickness of each layer

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setLayer_thickness

        DataNode setLayer_thickness(IDataset layer_thickness)
        An array describing the thickness of each layer

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        layer_thickness - the layer_thickness
      • getLayer_thicknessScalar

        java.lang.Double getLayer_thicknessScalar()
        An array describing the thickness of each layer

        Type: NX_FLOAT Units: NX_LENGTH

        Returns:
        the value.
      • setLayer_thicknessScalar

        DataNode setLayer_thicknessScalar(java.lang.Double layer_thickness)
        An array describing the thickness of each layer

        Type: NX_FLOAT Units: NX_LENGTH

        Parameters:
        layer_thickness - the layer_thickness
      • getShape

        NXshape getShape()
        A NXshape group describing the shape of the mirror
        Returns:
        the value.
      • setShape

        void setShape(NXshape shape)
        A NXshape group describing the shape of the mirror
        Parameters:
        shape - the shape
      • getFigure_data

        NXdata getFigure_data()
        Numerical description of the surface figure of the mirror.
        Returns:
        the value.
      • setFigure_data

        void setFigure_data(NXdata figure_data)
        Numerical description of the surface figure of the mirror.
        Parameters:
        figure_data - the figure_data




© 2015 - 2024 Weber Informatics LLC | Privacy Policy