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

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






NXsample_componentImpl (h5jan API)












org.eclipse.dawnsci.nexus.impl

Class NXsample_componentImpl

    • Field Detail

      • PERMITTED_CHILD_GROUP_CLASSES

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

      • NXsample_componentImpl

        public NXsample_componentImpl()
      • NXsample_componentImpl

        public NXsample_componentImpl(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
      • getChemical_formula

        public IDataset getChemical_formula()
        Description copied from interface: NXsample_component
        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.
        Specified by:
        getChemical_formula in interface NXsample_component
        Returns:
        the value.
      • getChemical_formulaScalar

        public java.lang.String getChemical_formulaScalar()
        Description copied from interface: NXsample_component
        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.
        Specified by:
        getChemical_formulaScalar in interface NXsample_component
        Returns:
        the value.
      • setChemical_formula

        public DataNode setChemical_formula(IDataset chemical_formula)
        Description copied from interface: NXsample_component
        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.
        Specified by:
        setChemical_formula in interface NXsample_component
        Parameters:
        chemical_formula - the chemical_formula
      • setChemical_formulaScalar

        public DataNode setChemical_formulaScalar(java.lang.String chemical_formula)
        Description copied from interface: NXsample_component
        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.
        Specified by:
        setChemical_formulaScalar in interface NXsample_component
        Parameters:
        chemical_formula - the chemical_formula
      • getUnit_cell_abc

        public IDataset getUnit_cell_abc()
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters a, b, and c

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

        Specified by:
        getUnit_cell_abc in interface NXsample_component
        Returns:
        the value.
      • getUnit_cell_abcScalar

        public java.lang.Double getUnit_cell_abcScalar()
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters a, b, and c

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

        Specified by:
        getUnit_cell_abcScalar in interface NXsample_component
        Returns:
        the value.
      • setUnit_cell_abc

        public DataNode setUnit_cell_abc(IDataset unit_cell_abc)
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters a, b, and c

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

        Specified by:
        setUnit_cell_abc in interface NXsample_component
        Parameters:
        unit_cell_abc - the unit_cell_abc
      • setUnit_cell_abcScalar

        public DataNode setUnit_cell_abcScalar(java.lang.Double unit_cell_abc)
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters a, b, and c

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

        Specified by:
        setUnit_cell_abcScalar in interface NXsample_component
        Parameters:
        unit_cell_abc - the unit_cell_abc
      • getUnit_cell_alphabetagamma

        public IDataset getUnit_cell_alphabetagamma()
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters alpha, beta, and gamma

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

        Specified by:
        getUnit_cell_alphabetagamma in interface NXsample_component
        Returns:
        the value.
      • getUnit_cell_alphabetagammaScalar

        public java.lang.Double getUnit_cell_alphabetagammaScalar()
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters alpha, beta, and gamma

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

        Specified by:
        getUnit_cell_alphabetagammaScalar in interface NXsample_component
        Returns:
        the value.
      • setUnit_cell_alphabetagamma

        public DataNode setUnit_cell_alphabetagamma(IDataset unit_cell_alphabetagamma)
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters alpha, beta, and gamma

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

        Specified by:
        setUnit_cell_alphabetagamma in interface NXsample_component
        Parameters:
        unit_cell_alphabetagamma - the unit_cell_alphabetagamma
      • setUnit_cell_alphabetagammaScalar

        public DataNode setUnit_cell_alphabetagammaScalar(java.lang.Double unit_cell_alphabetagamma)
        Description copied from interface: NXsample_component
        Crystallography unit cell parameters alpha, beta, and gamma

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

        Specified by:
        setUnit_cell_alphabetagammaScalar in interface NXsample_component
        Parameters:
        unit_cell_alphabetagamma - the unit_cell_alphabetagamma
      • setUnit_cell_volume

        public DataNode setUnit_cell_volume(IDataset unit_cell_volume)
        Description copied from interface: NXsample_component
        Volume of the unit cell

        Type: NX_FLOAT Units: NX_VOLUME

        Specified by:
        setUnit_cell_volume in interface NXsample_component
        Parameters:
        unit_cell_volume - the unit_cell_volume
      • getSample_orientation

        public IDataset getSample_orientation()
        Description copied from interface: NXsample_component
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

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

        Specified by:
        getSample_orientation in interface NXsample_component
        Returns:
        the value.
      • getSample_orientationScalar

        public java.lang.Double getSample_orientationScalar()
        Description copied from interface: NXsample_component
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

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

        Specified by:
        getSample_orientationScalar in interface NXsample_component
        Returns:
        the value.
      • setSample_orientation

        public DataNode setSample_orientation(IDataset sample_orientation)
        Description copied from interface: NXsample_component
        This will follow the Busing and Levy convention from Acta.Crysta v22, p457 (1967)

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

        Specified by:
        setSample_orientation in interface NXsample_component
        Parameters:
        sample_orientation - the sample_orientation
      • setSample_orientationScalar

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

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

        Specified by:
        setSample_orientationScalar in interface NXsample_component
        Parameters:
        sample_orientation - the sample_orientation
      • getOrientation_matrix

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

        Specified by:
        getOrientation_matrix in interface NXsample_component
        Returns:
        the value.
      • getOrientation_matrixScalar

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

        Specified by:
        getOrientation_matrixScalar in interface NXsample_component
        Returns:
        the value.
      • setOrientation_matrix

        public DataNode setOrientation_matrix(IDataset orientation_matrix)
        Description copied from interface: NXsample_component
        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;

        Specified by:
        setOrientation_matrix in interface NXsample_component
        Parameters:
        orientation_matrix - the orientation_matrix
      • setOrientation_matrixScalar

        public DataNode setOrientation_matrixScalar(java.lang.Double orientation_matrix)
        Description copied from interface: NXsample_component
        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;

        Specified by:
        setOrientation_matrixScalar in interface NXsample_component
        Parameters:
        orientation_matrix - the orientation_matrix
      • getMass

        public IDataset getMass()
        Description copied from interface: NXsample_component
        Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Specified by:
        getMass in interface NXsample_component
        Returns:
        the value.
      • getMassScalar

        public java.lang.Double getMassScalar()
        Description copied from interface: NXsample_component
        Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Specified by:
        getMassScalar in interface NXsample_component
        Returns:
        the value.
      • getDensity

        public IDataset getDensity()
        Description copied from interface: NXsample_component
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Specified by:
        getDensity in interface NXsample_component
        Returns:
        the value.
      • getDensityScalar

        public java.lang.Double getDensityScalar()
        Description copied from interface: NXsample_component
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Specified by:
        getDensityScalar in interface NXsample_component
        Returns:
        the value.
      • setDensity

        public DataNode setDensity(IDataset density)
        Description copied from interface: NXsample_component
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Specified by:
        setDensity in interface NXsample_component
        Parameters:
        density - the density
      • setDensityScalar

        public DataNode setDensityScalar(java.lang.Double density)
        Description copied from interface: NXsample_component
        Density of sample component

        Type: NX_FLOAT Units: NX_MASS_DENSITY

        Specified by:
        setDensityScalar in interface NXsample_component
        Parameters:
        density - the density
      • setRelative_molecular_mass

        public DataNode setRelative_molecular_mass(IDataset relative_molecular_mass)
        Description copied from interface: NXsample_component
        Relative Molecular Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Specified by:
        setRelative_molecular_mass in interface NXsample_component
        Parameters:
        relative_molecular_mass - the relative_molecular_mass
      • setRelative_molecular_massScalar

        public DataNode setRelative_molecular_massScalar(java.lang.Double relative_molecular_mass)
        Description copied from interface: NXsample_component
        Relative Molecular Mass of sample component

        Type: NX_FLOAT Units: NX_MASS

        Specified by:
        setRelative_molecular_massScalar in interface NXsample_component
        Parameters:
        relative_molecular_mass - the relative_molecular_mass
      • getScattering_length_density

        public IDataset getScattering_length_density()
        Description copied from interface: NXsample_component
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Specified by:
        getScattering_length_density in interface NXsample_component
        Returns:
        the value.
      • setScattering_length_density

        public DataNode setScattering_length_density(IDataset scattering_length_density)
        Description copied from interface: NXsample_component
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Specified by:
        setScattering_length_density in interface NXsample_component
        Parameters:
        scattering_length_density - the scattering_length_density
      • setScattering_length_densityScalar

        public DataNode setScattering_length_densityScalar(java.lang.Double scattering_length_density)
        Description copied from interface: NXsample_component
        Scattering length density of component

        Type: NX_FLOAT Units: NX_SCATTERING_LENGTH_DENSITY

        Specified by:
        setScattering_length_densityScalar in interface NXsample_component
        Parameters:
        scattering_length_density - the scattering_length_density
      • getUnit_cell_class

        public IDataset getUnit_cell_class()
        Description copied from interface: NXsample_component
        In case it is all we know and we want to record/document it

        Enumeration:

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

        Specified by:
        getUnit_cell_class in interface NXsample_component
        Returns:
        the value.
      • getUnit_cell_classScalar

        public java.lang.String getUnit_cell_classScalar()
        Description copied from interface: NXsample_component
        In case it is all we know and we want to record/document it

        Enumeration:

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

        Specified by:
        getUnit_cell_classScalar in interface NXsample_component
        Returns:
        the value.
      • setUnit_cell_class

        public DataNode setUnit_cell_class(IDataset unit_cell_class)
        Description copied from interface: NXsample_component
        In case it is all we know and we want to record/document it

        Enumeration:

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

        Specified by:
        setUnit_cell_class in interface NXsample_component
        Parameters:
        unit_cell_class - the unit_cell_class
      • setUnit_cell_classScalar

        public DataNode setUnit_cell_classScalar(java.lang.String unit_cell_class)
        Description copied from interface: NXsample_component
        In case it is all we know and we want to record/document it

        Enumeration:

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

        Specified by:
        setUnit_cell_classScalar in interface NXsample_component
        Parameters:
        unit_cell_class - the unit_cell_class
      • getPoint_group

        public IDataset getPoint_group()
        Description copied from interface: NXsample_component
        Crystallographic point group, deprecated if space_group present
        Specified by:
        getPoint_group in interface NXsample_component
        Returns:
        the value.
      • setPoint_group

        public DataNode setPoint_group(IDataset point_group)
        Description copied from interface: NXsample_component
        Crystallographic point group, deprecated if space_group present
        Specified by:
        setPoint_group in interface NXsample_component
        Parameters:
        point_group - the point_group
      • setPoint_groupScalar

        public DataNode setPoint_groupScalar(java.lang.String point_group)
        Description copied from interface: NXsample_component
        Crystallographic point group, deprecated if space_group present
        Specified by:
        setPoint_groupScalar in interface NXsample_component
        Parameters:
        point_group - the point_group




© 2015 - 2024 Weber Informatics LLC | Privacy Policy