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

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






NXsample_component (h5jan API)












org.eclipse.dawnsci.nexus

Interface NXsample_component

  • All Superinterfaces:
    GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject
    All Known Implementing Classes:
    NXsample_componentImpl


    public interface NXsample_component
    extends NXobject
    One group like this per component can be recorded For a sample consisting of multiple components.

    Symbols: symbolic array lengths to be coordinated between various fields

    • n_Temp number of temperatures
    • n_eField number of values in applied electric field
    • n_mField number of values in applied magnetic field
    • n_pField number of values in applied pressure field
    • n_sField number of values in applied stress field

    • Method Detail

      • getName

        IDataset getName()
        Descriptive name of sample component
        Returns:
        the value.
      • setName

        DataNode setName(IDataset name)
        Descriptive name of sample component
        Parameters:
        name - the name
      • getNameScalar

        java.lang.String getNameScalar()
        Descriptive name of sample component
        Returns:
        the value.
      • setNameScalar

        DataNode setNameScalar(java.lang.String name)
        Descriptive name of sample component
        Parameters:
        name - the name
      • getChemical_formula

        IDataset getChemical_formula()
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: - C, then H, then the other elements in alphabetical order of their symbol. - If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Returns:
        the value.
      • setChemical_formula

        DataNode setChemical_formula(IDataset chemical_formula)
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: - C, then H, then the other elements in alphabetical order of their symbol. - If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Parameters:
        chemical_formula - the chemical_formula
      • getChemical_formulaScalar

        java.lang.String getChemical_formulaScalar()
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: - C, then H, then the other elements in alphabetical order of their symbol. - If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Returns:
        the value.
      • setChemical_formulaScalar

        DataNode setChemical_formulaScalar(java.lang.String chemical_formula)
        The chemical formula specified using CIF conventions. Abbreviated version of CIF standard: * Only recognized element symbols may be used. * Each element symbol is followed by a 'count' number. A count of '1' may be omitted. * A space or parenthesis must separate each cluster of (element symbol + count). * Where a group of elements is enclosed in parentheses, the multiplier for the group must follow the closing parentheses. That is, all element and group multipliers are assumed to be printed as subscripted numbers. * Unless the elements are ordered in a manner that corresponds to their chemical structure, the order of the elements within any group or moiety depends on whether or not carbon is present. * If carbon is present, the order should be: - C, then H, then the other elements in alphabetical order of their symbol. - If carbon is not present, the elements are listed purely in alphabetic order of their symbol. * This is the *Hill* system used by Chemical Abstracts.
        Parameters:
        chemical_formula - the chemical_formula
      • getUnit_cell_abc

        IDataset getUnit_cell_abc()
        Crystallography unit cell parameters a, b, and c

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: 3;

        Returns:
        the value.
      • setUnit_cell_abc

        DataNode setUnit_cell_abc(IDataset unit_cell_abc)
        Crystallography unit cell parameters a, b, and c

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: 3;

        Parameters:
        unit_cell_abc - the unit_cell_abc
      • getUnit_cell_abcScalar

        java.lang.Double getUnit_cell_abcScalar()
        Crystallography unit cell parameters a, b, and c

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: 3;

        Returns:
        the value.
      • setUnit_cell_abcScalar

        DataNode setUnit_cell_abcScalar(java.lang.Double unit_cell_abc)
        Crystallography unit cell parameters a, b, and c

        Type: NX_FLOAT Units: NX_LENGTH Dimensions: 1: 3;

        Parameters:
        unit_cell_abc - the unit_cell_abc
      • getUnit_cell_alphabetagamma

        IDataset getUnit_cell_alphabetagamma()
        Crystallography unit cell parameters alpha, beta, and gamma

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Returns:
        the value.
      • setUnit_cell_alphabetagamma

        DataNode setUnit_cell_alphabetagamma(IDataset unit_cell_alphabetagamma)
        Crystallography unit cell parameters alpha, beta, and gamma

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Parameters:
        unit_cell_alphabetagamma - the unit_cell_alphabetagamma
      • getUnit_cell_alphabetagammaScalar

        java.lang.Double getUnit_cell_alphabetagammaScalar()
        Crystallography unit cell parameters alpha, beta, and gamma

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Returns:
        the value.
      • setUnit_cell_alphabetagammaScalar

        DataNode setUnit_cell_alphabetagammaScalar(java.lang.Double unit_cell_alphabetagamma)
        Crystallography unit cell parameters alpha, beta, and gamma

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Parameters:
        unit_cell_alphabetagamma - the unit_cell_alphabetagamma
      • getUnit_cell_volume

        IDataset getUnit_cell_volume()
        Volume of the unit cell

        Type: NX_FLOAT Units: NX_VOLUME

        Returns:
        the value.
      • setUnit_cell_volume

        DataNode setUnit_cell_volume(IDataset unit_cell_volume)
        Volume of the unit cell

        Type: NX_FLOAT Units: NX_VOLUME

        Parameters:
        unit_cell_volume - the unit_cell_volume
      • getUnit_cell_volumeScalar

        java.lang.Double getUnit_cell_volumeScalar()
        Volume of the unit cell

        Type: NX_FLOAT Units: NX_VOLUME

        Returns:
        the value.
      • setUnit_cell_volumeScalar

        DataNode setUnit_cell_volumeScalar(java.lang.Double unit_cell_volume)
        Volume of the unit cell

        Type: NX_FLOAT Units: NX_VOLUME

        Parameters:
        unit_cell_volume - the unit_cell_volume
      • getSample_orientation

        IDataset getSample_orientation()
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Returns:
        the value.
      • setSample_orientation

        DataNode setSample_orientation(IDataset sample_orientation)
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Parameters:
        sample_orientation - the sample_orientation
      • getSample_orientationScalar

        java.lang.Double getSample_orientationScalar()
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Returns:
        the value.
      • setSample_orientationScalar

        DataNode setSample_orientationScalar(java.lang.Double sample_orientation)
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Units: NX_ANGLE Dimensions: 1: 3;

        Parameters:
        sample_orientation - the sample_orientation
      • getOrientation_matrix

        IDataset getOrientation_matrix()
        Orientation matrix of single crystal sample component. This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Dimensions: 1: 3; 2: 3;

        Returns:
        the value.
      • setOrientation_matrix

        DataNode setOrientation_matrix(IDataset orientation_matrix)
        Orientation matrix of single crystal sample component. This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Dimensions: 1: 3; 2: 3;

        Parameters:
        orientation_matrix - the orientation_matrix
      • getOrientation_matrixScalar

        java.lang.Double getOrientation_matrixScalar()
        Orientation matrix of single crystal sample component. This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Dimensions: 1: 3; 2: 3;

        Returns:
        the value.
      • setOrientation_matrixScalar

        DataNode setOrientation_matrixScalar(java.lang.Double orientation_matrix)
        Orientation matrix of single crystal sample component. This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

        Type: NX_FLOAT Dimensions: 1: 3; 2: 3;

        Parameters:
        orientation_matrix - the orientation_matrix
      • getMass

        IDataset getMass()
        Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Returns:
        the value.
      • setMass

        DataNode setMass(IDataset mass)
        Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Parameters:
        mass - the mass
      • getMassScalar

        java.lang.Double getMassScalar()
        Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Returns:
        the value.
      • setMassScalar

        DataNode setMassScalar(java.lang.Double mass)
        Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Parameters:
        mass - the mass
      • getDensity

        IDataset getDensity()
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setDensity

        DataNode setDensity(IDataset density)
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        density - the density
      • getDensityScalar

        java.lang.Double getDensityScalar()
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Returns:
        the value.
      • setDensityScalar

        DataNode setDensityScalar(java.lang.Double density)
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Parameters:
        density - the density
      • getRelative_molecular_mass

        IDataset getRelative_molecular_mass()
        Relative Molecular Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Returns:
        the value.
      • setRelative_molecular_mass

        DataNode setRelative_molecular_mass(IDataset relative_molecular_mass)
        Relative Molecular Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Parameters:
        relative_molecular_mass - the relative_molecular_mass
      • getRelative_molecular_massScalar

        java.lang.Double getRelative_molecular_massScalar()
        Relative Molecular Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Returns:
        the value.
      • setRelative_molecular_massScalar

        DataNode setRelative_molecular_massScalar(java.lang.Double relative_molecular_mass)
        Relative Molecular Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Parameters:
        relative_molecular_mass - the relative_molecular_mass
      • getDescription

        IDataset getDescription()
        Description of the sample component
        Returns:
        the value.
      • setDescription

        DataNode setDescription(IDataset description)
        Description of the sample component
        Parameters:
        description - the description
      • getDescriptionScalar

        java.lang.String getDescriptionScalar()
        Description of the sample component
        Returns:
        the value.
      • setDescriptionScalar

        DataNode setDescriptionScalar(java.lang.String description)
        Description of the sample component
        Parameters:
        description - the description
      • getVolume_fraction

        IDataset getVolume_fraction()
        Volume fraction of component

        Type: NX_FLOAT

        Returns:
        the value.
      • setVolume_fraction

        DataNode setVolume_fraction(IDataset volume_fraction)
        Volume fraction of component

        Type: NX_FLOAT

        Parameters:
        volume_fraction - the volume_fraction
      • getVolume_fractionScalar

        java.lang.Double getVolume_fractionScalar()
        Volume fraction of component

        Type: NX_FLOAT

        Returns:
        the value.
      • setVolume_fractionScalar

        DataNode setVolume_fractionScalar(java.lang.Double volume_fraction)
        Volume fraction of component

        Type: NX_FLOAT

        Parameters:
        volume_fraction - the volume_fraction
      • getScattering_length_density

        IDataset getScattering_length_density()
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Returns:
        the value.
      • setScattering_length_density

        DataNode setScattering_length_density(IDataset scattering_length_density)
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Parameters:
        scattering_length_density - the scattering_length_density
      • getScattering_length_densityScalar

        java.lang.Double getScattering_length_densityScalar()
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Returns:
        the value.
      • setScattering_length_densityScalar

        DataNode setScattering_length_densityScalar(java.lang.Double scattering_length_density)
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Parameters:
        scattering_length_density - the scattering_length_density
      • getUnit_cell_class

        IDataset getUnit_cell_class()
        In case it is all we know and we want to record/document it

        Enumeration:

        • triclinic
        • monoclinic
        • orthorhombic
        • tetragonal
        • rhombohedral
        • hexagonal
        • cubic

        Returns:
        the value.
      • setUnit_cell_class

        DataNode setUnit_cell_class(IDataset unit_cell_class)
        In case it is all we know and we want to record/document it

        Enumeration:

        • triclinic
        • monoclinic
        • orthorhombic
        • tetragonal
        • rhombohedral
        • hexagonal
        • cubic

        Parameters:
        unit_cell_class - the unit_cell_class
      • getUnit_cell_classScalar

        java.lang.String getUnit_cell_classScalar()
        In case it is all we know and we want to record/document it

        Enumeration:

        • triclinic
        • monoclinic
        • orthorhombic
        • tetragonal
        • rhombohedral
        • hexagonal
        • cubic

        Returns:
        the value.
      • setUnit_cell_classScalar

        DataNode setUnit_cell_classScalar(java.lang.String unit_cell_class)
        In case it is all we know and we want to record/document it

        Enumeration:

        • triclinic
        • monoclinic
        • orthorhombic
        • tetragonal
        • rhombohedral
        • hexagonal
        • cubic

        Parameters:
        unit_cell_class - the unit_cell_class
      • getSpace_group

        IDataset getSpace_group()
        Crystallographic space group
        Returns:
        the value.
      • setSpace_group

        DataNode setSpace_group(IDataset space_group)
        Crystallographic space group
        Parameters:
        space_group - the space_group
      • getSpace_groupScalar

        java.lang.String getSpace_groupScalar()
        Crystallographic space group
        Returns:
        the value.
      • setSpace_groupScalar

        DataNode setSpace_groupScalar(java.lang.String space_group)
        Crystallographic space group
        Parameters:
        space_group - the space_group
      • getPoint_group

        IDataset getPoint_group()
        Crystallographic point group, deprecated if space_group present
        Returns:
        the value.
      • setPoint_group

        DataNode setPoint_group(IDataset point_group)
        Crystallographic point group, deprecated if space_group present
        Parameters:
        point_group - the point_group
      • getPoint_groupScalar

        java.lang.String getPoint_groupScalar()
        Crystallographic point group, deprecated if space_group present
        Returns:
        the value.
      • setPoint_groupScalar

        DataNode setPoint_groupScalar(java.lang.String point_group)
        Crystallographic point group, deprecated if space_group present
        Parameters:
        point_group - the point_group
      • getTransmission

        NXdata getTransmission()
        As a function of Wavelength
        Returns:
        the value.
      • setTransmission

        void setTransmission(NXdata transmission)
        As a function of Wavelength
        Parameters:
        transmission - the transmission




© 2015 - 2024 Weber Informatics LLC | Privacy Policy