Lens_Type

Bases: ManufacturerSpec_Type

Represents the XML complex type Lens.

This element describes additional lenses positioned in the Light Path for one or more Channels available for this Instrument. A Lens is a component of glass or transparent plastic material, usually circular, with two primary surfaces that are ground and polished in a specific manner designed to produce either a convergence or divergence of light passing through the material. An Instrument may have several Lenses with different functions, such as a Magnification Changer (also known as Optovar), a Coupling Lens connecting the Light Source with the Microscope Stand, a Relay Lens positioned at the Detector mount, or additional Lenses placed in the Light Path for various purposes. This element can be associated with an optional Optics Turret.

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LensID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LensID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setMagnification(value)

Sets the value of the Magnification attribute.

This field records the nominal Magnification provided by this Lens as specified by the Manufacturer.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getMagnification()

Returns the value of the Magnification attribute.

This field records the nominal Magnification provided by this Lens as specified by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

setLensNA(value)

Sets the value of the LensNA attribute.

This field captures the Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getLensNA()

Returns the value of the LensNA attribute.

This field captures the Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

Returns:

Type	Description
float	The value of the attribute

resetLensNA()

Resets the LensNA attribute to an unset state.

This field captures the Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

hasLensNA()

Checks whether the optional LensNA attribute is present.

This field captures the Numerical Aperture (NA) of this Lens expressed as a floating-point (real) number. NA is a number that was defined initially by Abbe to characterize Objectives and Condensers. NA can be calculated by the expression n sin alpha, where n is the Refractive Index of the medium between the Lens and the Sample, and alpha is half the Angular Aperture of the Lens. NA is a measure of how much of the illumination that leaves the specimen actually passes through the Lens. The larger the NA, the more information the lens can transmit. Expected range 0.02 - 1.5.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setInfinity(value)

Sets the value of the Infinity attribute.

This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getInfinity()

Returns the value of the Infinity attribute.

This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.

Returns:

Type	Description
boolean	The value of the attribute

resetInfinity()

Resets the Infinity attribute to an unset state.

This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.

hasInfinity()

Checks whether the optional Infinity attribute is present.

This field records whether (True) or not (False) this Lens is infinity corrected. An Infinity-corrected Lens is fixed for an infinite sample to primary Image distance. It needs to be used with a Tube Lens of appropriate focal length to obtain the specified magnification.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setComposite(value)

Sets the value of the Composite attribute.

This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getComposite()

Returns the value of the Composite attribute.

This field records whether this Lens is Composite (i.e., composed of multiple Lenses; True) or Simple (False).

Returns:

Type	Description
boolean	The value of the attribute

setShape(value)

Sets the value of the Shape attribute.

This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.

Parameters:

Name	Type	Description	Default
value	LensShapeType_Type	The value to set	required

getShape()

Returns the value of the Shape attribute.

This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.

Returns:

Type	Description
LensShapeType_Type	The value of the attribute

resetShape()

Resets the Shape attribute to an unset state.

This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.

hasShape()

Checks whether the optional Shape attribute is present.

This field records the shape of the profile (e.g., concave vs. convex) of this Lens. Please note that this attribute is often used to classify Lenses into categories.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setGeometry(value)

Sets the value of the Geometry attribute.

The geometrical shape of this lens' surface(s).

Parameters:

Name	Type	Description	Default
value	LensGeometry_Type	The value to set	required

getGeometry()

Returns the value of the Geometry attribute.

The geometrical shape of this lens' surface(s).

Returns:

Type	Description
LensGeometry_Type	The value of the attribute

resetGeometry()

Resets the Geometry attribute to an unset state.

The geometrical shape of this lens' surface(s).

hasGeometry()

Checks whether the optional Geometry attribute is present.

The geometrical shape of this lens' surface(s).

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDiameter(value)

Sets the value of the Diameter attribute.

This field records the physical diameter of this Lens.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getDiameter()

Returns the value of the Diameter attribute.

This field records the physical diameter of this Lens.

Returns:

Type	Description
float	The value of the attribute

resetDiameter()

Resets the Diameter attribute to an unset state.

This field records the physical diameter of this Lens.

hasDiameter()

Checks whether the optional Diameter attribute is present.

This field records the physical diameter of this Lens.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDiameterUnit(value)

Sets the value of the DiameterUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getDiameterUnit()

Returns the value of the DiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetDiameterUnit()

Resets the DiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasDiameterUnit()

Checks whether the optional DiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setCoating(value)

Sets the value of the Coating attribute.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getCoating()

Returns the value of the Coating attribute.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.

Returns:

Type	Description
string	The value of the attribute

resetCoating()

Resets the Coating attribute to an unset state.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.

hasCoating()

Checks whether the optional Coating attribute is present.

An optical Coating consists of one or more thin layers of material deposited on an optical component such as a Lens or Mirror, which alters the way in which the optic reflects and transmits light. This field records the optical Coating used for this Lens.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setAttenuationCoefficient(value)

Sets the value of the AttenuationCoefficient attribute.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAttenuationCoefficient()

Returns the value of the AttenuationCoefficient attribute.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Returns:

Type	Description
float	The value of the attribute

resetAttenuationCoefficient()

Resets the AttenuationCoefficient attribute to an unset state.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

hasAttenuationCoefficient()

Checks whether the optional AttenuationCoefficient attribute is present.

This field records the Attenuation Coefficient (AC) of this optical element. The AC (aka blocking coefficient) is a material property that characterizes the degree to which light is being blocked (i.e., scattered or absorbed) by it. AC is used as a measure of the out-of-band blocking of an optical Lens, Filter, Dichroic mirror over an extended range of the spectrum. AC is often reported in units of optical density (OD), whereas OD

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setWorkingDistance(value)

Sets the value of the WorkingDistance attribute.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getWorkingDistance()

Returns the value of the WorkingDistance attribute.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Returns:

Type	Description
float	The value of the attribute

resetWorkingDistance()

Resets the WorkingDistance attribute to an unset state.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

hasWorkingDistance()

Checks whether the optional WorkingDistance attribute is present.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setWorkingDistanceUnit(value)

Sets the value of the WorkingDistanceUnit attribute.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getWorkingDistanceUnit()

Returns the value of the WorkingDistanceUnit attribute.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetWorkingDistanceUnit()

Resets the WorkingDistanceUnit attribute to an unset state.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

hasWorkingDistanceUnit()

Checks whether the optional WorkingDistanceUnit attribute is present.

This field reports the Working Distance of this Lens under normal operating conditions. The Working Distance is the distance (in air, or in the specified immersion liquid) between the front of an Objective and the surface of the cover glass or of the specimen if uncovered.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setImageDistance(value)

Sets the value of the ImageDistance attribute.

This field records the distance in air between the rear principal Plane of this Lens and the primary Image Plane.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getImageDistance()

Returns the value of the ImageDistance attribute.

This field records the distance in air between the rear principal Plane of this Lens and the primary Image Plane.

Returns:

Type	Description
float	The value of the attribute

resetImageDistance()

Resets the ImageDistance attribute to an unset state.

This field records the distance in air between the rear principal Plane of this Lens and the primary Image Plane.

hasImageDistance()

Checks whether the optional ImageDistance attribute is present.

This field records the distance in air between the rear principal Plane of this Lens and the primary Image Plane.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setImageDistanceUnits(value)

Sets the value of the ImageDistanceUnits attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getImageDistanceUnits()

Returns the value of the ImageDistanceUnits attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetImageDistanceUnits()

Resets the ImageDistanceUnits attribute to an unset state.

No description available in the XSD standard.

hasImageDistanceUnits()

Checks whether the optional ImageDistanceUnits attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setFrontFocalLength(value)

Sets the value of the FrontFocalLength attribute.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getFrontFocalLength()

Returns the value of the FrontFocalLength attribute.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

Returns:

Type	Description
float	The value of the attribute

resetFrontFocalLength()

Resets the FrontFocalLength attribute to an unset state.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

hasFrontFocalLength()

Checks whether the optional FrontFocalLength attribute is present.

This field records the distance (f) measured along the optical axis from the front principal Plane of this Lens to the front focal Plane (F).

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setFrontFocalLengthUnit(value)

Sets the value of the FrontFocalLengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getFrontFocalLengthUnit()

Returns the value of the FrontFocalLengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetFrontFocalLengthUnit()

Resets the FrontFocalLengthUnit attribute to an unset state.

No description available in the XSD standard.

hasFrontFocalLengthUnit()

Checks whether the optional FrontFocalLengthUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setBackFocalLength(value)

Sets the value of the BackFocalLength attribute.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getBackFocalLength()

Returns the value of the BackFocalLength attribute.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

Returns:

Type	Description
float	The value of the attribute

resetBackFocalLength()

Resets the BackFocalLength attribute to an unset state.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

hasBackFocalLength()

Checks whether the optional BackFocalLength attribute is present.

This field records the distance (f') measured along the optical axis from the rear principal Plane of this Lens to the rear focal Plane (F').

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setBackFocalLengthUnit(value)

Sets the value of the BackFocalLengthUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getBackFocalLengthUnit()

Returns the value of the BackFocalLengthUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetBackFocalLengthUnit()

Resets the BackFocalLengthUnit attribute to an unset state.

No description available in the XSD standard.

hasBackFocalLengthUnit()

Checks whether the optional BackFocalLengthUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setRadiusOfCurvature(value)

Sets the value of the RadiusOfCurvature attribute.

This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getRadiusOfCurvature()

Returns the value of the RadiusOfCurvature attribute.

This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.

Returns:

Type	Description
float	The value of the attribute

resetRadiusOfCurvature()

Resets the RadiusOfCurvature attribute to an unset state.

This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.

hasRadiusOfCurvature()

Checks whether the optional RadiusOfCurvature attribute is present.

This field records the Radius of Curvature of this Lens. A spherical Lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the Radius of Curvature of the surface.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setRadiusOfCurvatureUnit(value)

Sets the value of the RadiusOfCurvatureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getRadiusOfCurvatureUnit()

Returns the value of the RadiusOfCurvatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetRadiusOfCurvatureUnit()

Resets the RadiusOfCurvatureUnit attribute to an unset state.

No description available in the XSD standard.

hasRadiusOfCurvatureUnit()

Checks whether the optional RadiusOfCurvatureUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setMaterialName(value)

Sets the value of the MaterialName attribute.

This field records the chemical composition or designation of the Material this Lens is made of.

Parameters:

Name	Type	Description	Default
value	OpticalMaterialName_Type	The value to set	required

getMaterialName()

Returns the value of the MaterialName attribute.

This field records the chemical composition or designation of the Material this Lens is made of.

Returns:

Type	Description
OpticalMaterialName_Type	The value of the attribute

resetMaterialName()

Resets the MaterialName attribute to an unset state.

This field records the chemical composition or designation of the Material this Lens is made of.

hasMaterialName()

Checks whether the optional MaterialName attribute is present.

This field records the chemical composition or designation of the Material this Lens is made of.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setGlassCode(value)

Sets the value of the GlassCode attribute.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getGlassCode()

Returns the value of the GlassCode attribute.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Returns:

Type	Description
string	The value of the attribute

resetGlassCode()

Resets the GlassCode attribute to an unset state.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

hasGlassCode()

Checks whether the optional GlassCode attribute is present.

If available, this field records the international Glass Code of the material that constitutes this Lens. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setRefractiveIndex(value)

Sets the value of the RefractiveIndex attribute.

This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.

Returns:

Type	Description
float	The value of the attribute

resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.

hasRefractiveIndex()

Checks whether the optional RefractiveIndex attribute is present.

This field records the Refractive Index of the material this Lens is made of, as specified by the Manufacturer. The Refractive Index is the ratio of the speed of light (more precisely, the phase velocity) in a vacuum versus that in a given medium.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setAbbeNumber(value)

Sets the value of the AbbeNumber attribute.

This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getAbbeNumber()

Returns the value of the AbbeNumber attribute.

This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

Returns:

Type	Description
float	The value of the attribute

resetAbbeNumber()

Resets the AbbeNumber attribute to an unset state.

This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

hasAbbeNumber()

Checks whether the optional AbbeNumber attribute is present.

This field records the Abbe number of this Lens. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDensity(value)

Sets the value of the Density attribute.

This field records the Density of the material this Lens is made of.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getDensity()

Returns the value of the Density attribute.

This field records the Density of the material this Lens is made of.

Returns:

Type	Description
float	The value of the attribute

resetDensity()

Resets the Density attribute to an unset state.

This field records the Density of the material this Lens is made of.

hasDensity()

Checks whether the optional Density attribute is present.

This field records the Density of the material this Lens is made of.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDensityUnit(value)

Sets the value of the DensityUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsDensity_Type	The value to set	required

getDensityUnit()

Returns the value of the DensityUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsDensity_Type	The value of the attribute

resetDensityUnit()

Resets the DensityUnit attribute to an unset state.

No description available in the XSD standard.

hasDensityUnit()

Checks whether the optional DensityUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise