com.inscoper.nbo.Lens_Type¶

Represents the XML complex type Lens. More...

Inherits from com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Inherited by com.inscoper.nbo.BeamCollimatorLens, com.inscoper.nbo.BeamExpanderLens, com.inscoper.nbo.CondenserLens, com.inscoper.nbo.CouplingLens, com.inscoper.nbo.GenericLens, com.inscoper.nbo.MagnificationChanger, com.inscoper.nbo.RelayLens, com.inscoper.nbo.TubeLens

Public Functions¶

	Name
synchronized void	delete()
	Lens_Type()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(LensID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LensID_Type value) Sets the value of the ID attribute.
LensID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setMagnification(float value, boolean validate) Sets the value of the Magnification attribute.
void	setMagnification(float value) Sets the value of the Magnification attribute.
float	getMagnification() Returns the value of the Magnification attribute.
void	resetMagnification() Resets the Magnification attribute to an unset state.
boolean	hasMagnification() Checks whether the Magnification attribute is present.
void	setLensNA(float value, boolean validate) Sets the value of the LensNA attribute.
void	setLensNA(float value) Sets the value of the LensNA attribute.
float	getLensNA() Returns the value of the LensNA attribute.
void	resetLensNA() Resets the LensNA attribute to an unset state.
boolean	hasLensNA() Checks whether the LensNA attribute is present.
void	setInfinity(boolean value, boolean validate) Sets the value of the Infinity attribute.
void	setInfinity(boolean value) Sets the value of the Infinity attribute.
boolean	getInfinity() Returns the value of the Infinity attribute.
void	resetInfinity() Resets the Infinity attribute to an unset state.
boolean	hasInfinity() Checks whether the Infinity attribute is present.
void	setComposite(boolean value, boolean validate) Sets the value of the Composite attribute.
void	setComposite(boolean value) Sets the value of the Composite attribute.
boolean	getComposite() Returns the value of the Composite attribute.
void	resetComposite() Resets the Composite attribute to an unset state.
boolean	hasComposite() Checks whether the Composite attribute is present.
void	setShape(LensShapeType_Type value, boolean validate) Sets the value of the Shape attribute.
void	setShape(LensShapeType_Type value) Sets the value of the Shape attribute.
LensShapeType_Type	getShape() Returns the value of the Shape attribute.
void	resetShape() Resets the Shape attribute to an unset state.
boolean	hasShape() Checks whether the optional Shape attribute is present.
void	setGeometry(LensGeometry_Type value, boolean validate) Sets the value of the Geometry attribute.
void	setGeometry(LensGeometry_Type value) Sets the value of the Geometry attribute.
LensGeometry_Type	getGeometry() Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
boolean	hasGeometry() Checks whether the optional Geometry attribute is present.
void	setDiameter(float value, boolean validate) Sets the value of the Diameter attribute.
void	setDiameter(float value) Sets the value of the Diameter attribute.
float	getDiameter() Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
boolean	hasDiameter() Checks whether the Diameter attribute is present.
void	setDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the DiameterUnit attribute.
void	setDiameterUnit(UnitsLength_Type value) Sets the value of the DiameterUnit attribute.
UnitsLength_Type	getDiameterUnit() Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
boolean	hasDiameterUnit() Checks whether the optional DiameterUnit attribute is present.
void	setCoating(String value, boolean validate) Sets the value of the Coating attribute.
void	setCoating(String value) Sets the value of the Coating attribute.
String	getCoating() Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
boolean	hasCoating() Checks whether the Coating attribute is present.
void	setAttenuationCoefficient(float value, boolean validate) Sets the value of the AttenuationCoefficient attribute.
void	setAttenuationCoefficient(float value) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
boolean	hasAttenuationCoefficient() Checks whether the AttenuationCoefficient attribute is present.
void	setWorkingDistance(float value, boolean validate) Sets the value of the WorkingDistance attribute.
void	setWorkingDistance(float value) Sets the value of the WorkingDistance attribute.
float	getWorkingDistance() Returns the value of the WorkingDistance attribute.
void	resetWorkingDistance() Resets the WorkingDistance attribute to an unset state.
boolean	hasWorkingDistance() Checks whether the WorkingDistance attribute is present.
void	setWorkingDistanceUnit(UnitsLength_Type value, boolean validate) Sets the value of the WorkingDistanceUnit attribute.
void	setWorkingDistanceUnit(UnitsLength_Type value) Sets the value of the WorkingDistanceUnit attribute.
UnitsLength_Type	getWorkingDistanceUnit() Returns the value of the WorkingDistanceUnit attribute.
void	resetWorkingDistanceUnit() Resets the WorkingDistanceUnit attribute to an unset state.
boolean	hasWorkingDistanceUnit() Checks whether the optional WorkingDistanceUnit attribute is present.
void	setImageDistance(float value, boolean validate) Sets the value of the ImageDistance attribute.
void	setImageDistance(float value) Sets the value of the ImageDistance attribute.
float	getImageDistance() Returns the value of the ImageDistance attribute.
void	resetImageDistance() Resets the ImageDistance attribute to an unset state.
boolean	hasImageDistance() Checks whether the ImageDistance attribute is present.
void	setImageDistanceUnits(UnitsLength_Type value, boolean validate) Sets the value of the ImageDistanceUnits attribute.
void	setImageDistanceUnits(UnitsLength_Type value) Sets the value of the ImageDistanceUnits attribute.
UnitsLength_Type	getImageDistanceUnits() Returns the value of the ImageDistanceUnits attribute.
void	resetImageDistanceUnits() Resets the ImageDistanceUnits attribute to an unset state.
boolean	hasImageDistanceUnits() Checks whether the optional ImageDistanceUnits attribute is present.
void	setFrontFocalLength(float value, boolean validate) Sets the value of the FrontFocalLength attribute.
void	setFrontFocalLength(float value) Sets the value of the FrontFocalLength attribute.
float	getFrontFocalLength() Returns the value of the FrontFocalLength attribute.
void	resetFrontFocalLength() Resets the FrontFocalLength attribute to an unset state.
boolean	hasFrontFocalLength() Checks whether the FrontFocalLength attribute is present.
void	setFrontFocalLengthUnit(UnitsLength_Type value, boolean validate) Sets the value of the FrontFocalLengthUnit attribute.
void	setFrontFocalLengthUnit(UnitsLength_Type value) Sets the value of the FrontFocalLengthUnit attribute.
UnitsLength_Type	getFrontFocalLengthUnit() Returns the value of the FrontFocalLengthUnit attribute.
void	resetFrontFocalLengthUnit() Resets the FrontFocalLengthUnit attribute to an unset state.
boolean	hasFrontFocalLengthUnit() Checks whether the optional FrontFocalLengthUnit attribute is present.
void	setBackFocalLength(float value, boolean validate) Sets the value of the BackFocalLength attribute.
void	setBackFocalLength(float value) Sets the value of the BackFocalLength attribute.
float	getBackFocalLength() Returns the value of the BackFocalLength attribute.
void	resetBackFocalLength() Resets the BackFocalLength attribute to an unset state.
boolean	hasBackFocalLength() Checks whether the BackFocalLength attribute is present.
void	setBackFocalLengthUnit(UnitsLength_Type value, boolean validate) Sets the value of the BackFocalLengthUnit attribute.
void	setBackFocalLengthUnit(UnitsLength_Type value) Sets the value of the BackFocalLengthUnit attribute.
UnitsLength_Type	getBackFocalLengthUnit() Returns the value of the BackFocalLengthUnit attribute.
void	resetBackFocalLengthUnit() Resets the BackFocalLengthUnit attribute to an unset state.
boolean	hasBackFocalLengthUnit() Checks whether the optional BackFocalLengthUnit attribute is present.
void	setRadiusOfCurvature(float value, boolean validate) Sets the value of the RadiusOfCurvature attribute.
void	setRadiusOfCurvature(float value) Sets the value of the RadiusOfCurvature attribute.
float	getRadiusOfCurvature() Returns the value of the RadiusOfCurvature attribute.
void	resetRadiusOfCurvature() Resets the RadiusOfCurvature attribute to an unset state.
boolean	hasRadiusOfCurvature() Checks whether the RadiusOfCurvature attribute is present.
void	setRadiusOfCurvatureUnit(UnitsLength_Type value, boolean validate) Sets the value of the RadiusOfCurvatureUnit attribute.
void	setRadiusOfCurvatureUnit(UnitsLength_Type value) Sets the value of the RadiusOfCurvatureUnit attribute.
UnitsLength_Type	getRadiusOfCurvatureUnit() Returns the value of the RadiusOfCurvatureUnit attribute.
void	resetRadiusOfCurvatureUnit() Resets the RadiusOfCurvatureUnit attribute to an unset state.
boolean	hasRadiusOfCurvatureUnit() Checks whether the optional RadiusOfCurvatureUnit attribute is present.
void	setMaterialName(OpticalMaterialName_Type value, boolean validate) Sets the value of the MaterialName attribute.
void	setMaterialName(OpticalMaterialName_Type value) Sets the value of the MaterialName attribute.
OpticalMaterialName_Type	getMaterialName() Returns the value of the MaterialName attribute.
void	resetMaterialName() Resets the MaterialName attribute to an unset state.
boolean	hasMaterialName() Checks whether the optional MaterialName attribute is present.
void	setGlassCode(String value, boolean validate) Sets the value of the GlassCode attribute.
void	setGlassCode(String value) Sets the value of the GlassCode attribute.
String	getGlassCode() Returns the value of the GlassCode attribute.
void	resetGlassCode() Resets the GlassCode attribute to an unset state.
boolean	hasGlassCode() Checks whether the GlassCode attribute is present.
void	setRefractiveIndex(float value, boolean validate) Sets the value of the RefractiveIndex attribute.
void	setRefractiveIndex(float value) Sets the value of the RefractiveIndex attribute.
float	getRefractiveIndex() Returns the value of the RefractiveIndex attribute.
void	resetRefractiveIndex() Resets the RefractiveIndex attribute to an unset state.
boolean	hasRefractiveIndex() Checks whether the RefractiveIndex attribute is present.
void	setAbbeNumber(float value, boolean validate) Sets the value of the AbbeNumber attribute.
void	setAbbeNumber(float value) Sets the value of the AbbeNumber attribute.
float	getAbbeNumber() Returns the value of the AbbeNumber attribute.
void	resetAbbeNumber() Resets the AbbeNumber attribute to an unset state.
boolean	hasAbbeNumber() Checks whether the AbbeNumber attribute is present.
void	setDensity(float value, boolean validate) Sets the value of the Density attribute.
void	setDensity(float value) Sets the value of the Density attribute.
float	getDensity() Returns the value of the Density attribute.
void	resetDensity() Resets the Density attribute to an unset state.
boolean	hasDensity() Checks whether the Density attribute is present.
void	setDensityUnit(UnitsDensity_Type value, boolean validate) Sets the value of the DensityUnit attribute.
void	setDensityUnit(UnitsDensity_Type value) Sets the value of the DensityUnit attribute.
UnitsDensity_Type	getDensityUnit() Returns the value of the DensityUnit attribute.
void	resetDensityUnit() Resets the DensityUnit attribute to an unset state.
boolean	hasDensityUnit() Checks whether the optional DensityUnit attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
Lens_Type	__internal_create(long cPtr, boolean own)
Lens_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Lens_Type.
StringSet	getCoatingAllowedValues() Returns the allowed values for this attribut.
StringSet	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Lens_Type(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Lens_Type obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Lens_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.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.delete, com.inscoper.nbo.BeamExpanderLens.delete, com.inscoper.nbo.CondenserLens.delete, com.inscoper.nbo.CouplingLens.delete, com.inscoper.nbo.GenericLens.delete, com.inscoper.nbo.MagnificationChanger.delete, com.inscoper.nbo.RelayLens.delete, com.inscoper.nbo.TubeLens.delete

function Lens_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getTypeName

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.getTypeName, com.inscoper.nbo.BeamExpanderLens.getTypeName, com.inscoper.nbo.CondenserLens.getTypeName, com.inscoper.nbo.CouplingLens.getTypeName, com.inscoper.nbo.GenericLens.getTypeName, com.inscoper.nbo.MagnificationChanger.getTypeName, com.inscoper.nbo.RelayLens.getTypeName, com.inscoper.nbo.TubeLens.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getXMLName

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.getXMLName, com.inscoper.nbo.BeamExpanderLens.getXMLName, com.inscoper.nbo.CondenserLens.getXMLName, com.inscoper.nbo.CouplingLens.getXMLName, com.inscoper.nbo.GenericLens.getXMLName, com.inscoper.nbo.MagnificationChanger.getXMLName, com.inscoper.nbo.RelayLens.getXMLName, com.inscoper.nbo.TubeLens.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getNBOType

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.getNBOType, com.inscoper.nbo.BeamExpanderLens.getNBOType, com.inscoper.nbo.CondenserLens.getNBOType, com.inscoper.nbo.CouplingLens.getNBOType, com.inscoper.nbo.GenericLens.getNBOType, com.inscoper.nbo.MagnificationChanger.getNBOType, com.inscoper.nbo.RelayLens.getNBOType, com.inscoper.nbo.TubeLens.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getChildren

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.getChildren, com.inscoper.nbo.BeamExpanderLens.getChildren, com.inscoper.nbo.CondenserLens.getChildren, com.inscoper.nbo.CouplingLens.getChildren, com.inscoper.nbo.GenericLens.getChildren, com.inscoper.nbo.MagnificationChanger.getChildren, com.inscoper.nbo.RelayLens.getChildren, com.inscoper.nbo.TubeLens.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

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

Return: The list of child classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getSubElements

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.getSubElements, com.inscoper.nbo.BeamExpanderLens.getSubElements, com.inscoper.nbo.CondenserLens.getSubElements, com.inscoper.nbo.CouplingLens.getSubElements, com.inscoper.nbo.GenericLens.getSubElements, com.inscoper.nbo.MagnificationChanger.getSubElements, com.inscoper.nbo.RelayLens.getSubElements, com.inscoper.nbo.TubeLens.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromJsonFile, com.inscoper.nbo.BeamExpanderLens.fromJsonFile, com.inscoper.nbo.CondenserLens.fromJsonFile, com.inscoper.nbo.CouplingLens.fromJsonFile, com.inscoper.nbo.GenericLens.fromJsonFile, com.inscoper.nbo.MagnificationChanger.fromJsonFile, com.inscoper.nbo.RelayLens.fromJsonFile, com.inscoper.nbo.TubeLens.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromJsonFile, com.inscoper.nbo.BeamExpanderLens.fromJsonFile, com.inscoper.nbo.CondenserLens.fromJsonFile, com.inscoper.nbo.CouplingLens.fromJsonFile, com.inscoper.nbo.GenericLens.fromJsonFile, com.inscoper.nbo.MagnificationChanger.fromJsonFile, com.inscoper.nbo.RelayLens.fromJsonFile, com.inscoper.nbo.TubeLens.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromJsonString, com.inscoper.nbo.BeamExpanderLens.fromJsonString, com.inscoper.nbo.CondenserLens.fromJsonString, com.inscoper.nbo.CouplingLens.fromJsonString, com.inscoper.nbo.GenericLens.fromJsonString, com.inscoper.nbo.MagnificationChanger.fromJsonString, com.inscoper.nbo.RelayLens.fromJsonString, com.inscoper.nbo.TubeLens.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromJsonString, com.inscoper.nbo.BeamExpanderLens.fromJsonString, com.inscoper.nbo.CondenserLens.fromJsonString, com.inscoper.nbo.CouplingLens.fromJsonString, com.inscoper.nbo.GenericLens.fromJsonString, com.inscoper.nbo.MagnificationChanger.fromJsonString, com.inscoper.nbo.RelayLens.fromJsonString, com.inscoper.nbo.TubeLens.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromXmlFile, com.inscoper.nbo.BeamExpanderLens.fromXmlFile, com.inscoper.nbo.CondenserLens.fromXmlFile, com.inscoper.nbo.CouplingLens.fromXmlFile, com.inscoper.nbo.GenericLens.fromXmlFile, com.inscoper.nbo.MagnificationChanger.fromXmlFile, com.inscoper.nbo.RelayLens.fromXmlFile, com.inscoper.nbo.TubeLens.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromXmlFile, com.inscoper.nbo.BeamExpanderLens.fromXmlFile, com.inscoper.nbo.CondenserLens.fromXmlFile, com.inscoper.nbo.CouplingLens.fromXmlFile, com.inscoper.nbo.GenericLens.fromXmlFile, com.inscoper.nbo.MagnificationChanger.fromXmlFile, com.inscoper.nbo.RelayLens.fromXmlFile, com.inscoper.nbo.TubeLens.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromXmlString, com.inscoper.nbo.BeamExpanderLens.fromXmlString, com.inscoper.nbo.CondenserLens.fromXmlString, com.inscoper.nbo.CouplingLens.fromXmlString, com.inscoper.nbo.GenericLens.fromXmlString, com.inscoper.nbo.MagnificationChanger.fromXmlString, com.inscoper.nbo.RelayLens.fromXmlString, com.inscoper.nbo.TubeLens.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromXmlString, com.inscoper.nbo.BeamExpanderLens.fromXmlString, com.inscoper.nbo.CondenserLens.fromXmlString, com.inscoper.nbo.CouplingLens.fromXmlString, com.inscoper.nbo.GenericLens.fromXmlString, com.inscoper.nbo.MagnificationChanger.fromXmlString, com.inscoper.nbo.RelayLens.fromXmlString, com.inscoper.nbo.TubeLens.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.toXmlFile, com.inscoper.nbo.BeamExpanderLens.toXmlFile, com.inscoper.nbo.CondenserLens.toXmlFile, com.inscoper.nbo.CouplingLens.toXmlFile, com.inscoper.nbo.GenericLens.toXmlFile, com.inscoper.nbo.MagnificationChanger.toXmlFile, com.inscoper.nbo.RelayLens.toXmlFile, com.inscoper.nbo.TubeLens.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.toXmlFile, com.inscoper.nbo.BeamExpanderLens.toXmlFile, com.inscoper.nbo.CondenserLens.toXmlFile, com.inscoper.nbo.CouplingLens.toXmlFile, com.inscoper.nbo.GenericLens.toXmlFile, com.inscoper.nbo.MagnificationChanger.toXmlFile, com.inscoper.nbo.RelayLens.toXmlFile, com.inscoper.nbo.TubeLens.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlString

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.toXmlString, com.inscoper.nbo.BeamExpanderLens.toXmlString, com.inscoper.nbo.CondenserLens.toXmlString, com.inscoper.nbo.CouplingLens.toXmlString, com.inscoper.nbo.GenericLens.toXmlString, com.inscoper.nbo.MagnificationChanger.toXmlString, com.inscoper.nbo.RelayLens.toXmlString, com.inscoper.nbo.TubeLens.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlString

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.toXmlString, com.inscoper.nbo.BeamExpanderLens.toXmlString, com.inscoper.nbo.CondenserLens.toXmlString, com.inscoper.nbo.CouplingLens.toXmlString, com.inscoper.nbo.GenericLens.toXmlString, com.inscoper.nbo.MagnificationChanger.toXmlString, com.inscoper.nbo.RelayLens.toXmlString, com.inscoper.nbo.TubeLens.toXmlString

function setID¶

public void setID(
    LensID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

public void setName(
    Denomination_Type value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A User-defined Name for this component.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setMagnification¶

public void setMagnification(
    float value,
    boolean validate
)

Sets the value of the Magnification attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setMagnification¶

public void setMagnification(
    float value
)

Sets the value of the Magnification attribute.

Parameters:

value The value to set

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

function getMagnification¶

public float getMagnification()

Returns the value of the Magnification attribute.

Return: The value of the attribute

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

function resetMagnification¶

function hasMagnification¶

public boolean hasMagnification()

Checks whether the Magnification attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setLensNA¶

public void setLensNA(
    float value,
    boolean validate
)

Sets the value of the LensNA attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setLensNA¶

public void setLensNA(
    float value
)

Sets the value of the LensNA attribute.

Parameters:

value The value to set

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.

function getLensNA¶

public float getLensNA()

Returns the value of the LensNA attribute.

Return: The value of the 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.

function resetLensNA¶

public void 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.

function hasLensNA¶

public boolean hasLensNA()

Checks whether the LensNA attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setInfinity¶

public void setInfinity(
    boolean value,
    boolean validate
)

Sets the value of the Infinity attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setInfinity¶

public void setInfinity(
    boolean value
)

Sets the value of the Infinity attribute.

Parameters:

value The value to set

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.

function getInfinity¶

public boolean getInfinity()

Returns the value of the Infinity attribute.

Return: The value of the 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.

function resetInfinity¶

public void 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.

function hasInfinity¶

public boolean hasInfinity()

Checks whether the Infinity attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setComposite¶

public void setComposite(
    boolean value,
    boolean validate
)

Sets the value of the Composite attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setComposite¶

public void setComposite(
    boolean value
)

Sets the value of the Composite attribute.

Parameters:

value The value to set

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

function getComposite¶

public boolean getComposite()

Returns the value of the Composite attribute.

Return: The value of the attribute

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

function resetComposite¶

function hasComposite¶

public boolean hasComposite()

Checks whether the Composite attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setShape¶

public void setShape(
    LensShapeType_Type value,
    boolean validate
)

Sets the value of the Shape attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setShape¶

public void setShape(
    LensShapeType_Type value
)

Sets the value of the Shape attribute.

Parameters:

value The value to set

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.

function getShape¶

public LensShapeType_Type getShape()

Returns the value of the Shape attribute.

Return: The value of the 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.

function resetShape¶

public void 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.

function hasShape¶

public boolean hasShape()

Checks whether the optional Shape attribute is present.

Return: true if the optional attribute has been set, false otherwise

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.

function setGeometry¶

public void setGeometry(
    LensGeometry_Type value,
    boolean validate
)

Sets the value of the Geometry attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setGeometry¶

function getGeometry¶

function resetGeometry¶

function hasGeometry¶

public boolean hasGeometry()

Checks whether the optional Geometry attribute is present.

Return: true if the optional attribute has been set, false otherwise

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

function setDiameter¶

public void setDiameter(
    float value,
    boolean validate
)

Sets the value of the Diameter attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the physical diameter of this Lens.

function setDiameter¶

function getDiameter¶

function resetDiameter¶

function hasDiameter¶

function setDiameterUnit¶

public void setDiameterUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the DiameterUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setDiameterUnit¶

function getDiameterUnit¶

function resetDiameterUnit¶

function hasDiameterUnit¶

public boolean hasDiameterUnit()

Checks whether the optional DiameterUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setCoating¶

public void setCoating(
    String value,
    boolean validate
)

Sets the value of the Coating attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setCoating¶

public void setCoating(
    String value
)

Sets the value of the Coating attribute.

Parameters:

value The value to set

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.

function getCoating¶

public String getCoating()

Returns the value of the Coating attribute.

Return: The value of the 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.

function resetCoating¶

public void 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.

function hasCoating¶

public boolean hasCoating()

Checks whether the Coating attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setAttenuationCoefficient¶

public void setAttenuationCoefficient(
    float value,
    boolean validate
)

Sets the value of the AttenuationCoefficient attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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= -log10(T), and T=Transmittance (0≤T≤1).

function setAttenuationCoefficient¶

public void setAttenuationCoefficient(
    float value
)

Sets the value of the AttenuationCoefficient attribute.

Parameters:

value The value to set

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= -log10(T), and T=Transmittance (0≤T≤1).

function getAttenuationCoefficient¶

public float getAttenuationCoefficient()

Returns the value of the AttenuationCoefficient attribute.

Return: The value of the 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= -log10(T), and T=Transmittance (0≤T≤1).

function resetAttenuationCoefficient¶

public void 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= -log10(T), and T=Transmittance (0≤T≤1).

function hasAttenuationCoefficient¶

public boolean hasAttenuationCoefficient()

Checks whether the AttenuationCoefficient attribute is present.

Return: true if the attribute has been set, false otherwise

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= -log10(T), and T=Transmittance (0≤T≤1).

function setWorkingDistance¶

public void setWorkingDistance(
    float value,
    boolean validate
)

Sets the value of the WorkingDistance attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setWorkingDistance¶

public void setWorkingDistance(
    float value
)

Sets the value of the WorkingDistance attribute.

Parameters:

value The value to set

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.

function getWorkingDistance¶

public float getWorkingDistance()

Returns the value of the WorkingDistance attribute.

Return: The value of the 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.

function resetWorkingDistance¶

public void 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.

function hasWorkingDistance¶

public boolean hasWorkingDistance()

Checks whether the WorkingDistance attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setWorkingDistanceUnit¶

public void setWorkingDistanceUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the WorkingDistanceUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setWorkingDistanceUnit¶

public void setWorkingDistanceUnit(
    UnitsLength_Type value
)

Sets the value of the WorkingDistanceUnit attribute.

Parameters:

value The value to set

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.

function getWorkingDistanceUnit¶

public UnitsLength_Type getWorkingDistanceUnit()

Returns the value of the WorkingDistanceUnit attribute.

Return: The value of the 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.

function resetWorkingDistanceUnit¶

public void 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.

function hasWorkingDistanceUnit¶

public boolean hasWorkingDistanceUnit()

Checks whether the optional WorkingDistanceUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

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.

function setImageDistance¶

public void setImageDistance(
    float value,
    boolean validate
)

Sets the value of the ImageDistance attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setImageDistance¶

public void setImageDistance(
    float value
)

Sets the value of the ImageDistance attribute.

Parameters:

value The value to set

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

function getImageDistance¶

public float getImageDistance()

Returns the value of the ImageDistance attribute.

Return: The value of the attribute

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

function resetImageDistance¶

public void 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.

function hasImageDistance¶

public boolean hasImageDistance()

Checks whether the ImageDistance attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setImageDistanceUnits¶

public void setImageDistanceUnits(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the ImageDistanceUnits attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setImageDistanceUnits¶

public void setImageDistanceUnits(
    UnitsLength_Type value
)

Sets the value of the ImageDistanceUnits attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getImageDistanceUnits¶

function resetImageDistanceUnits¶

function hasImageDistanceUnits¶

public boolean hasImageDistanceUnits()

Checks whether the optional ImageDistanceUnits attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setFrontFocalLength¶

public void setFrontFocalLength(
    float value,
    boolean validate
)

Sets the value of the FrontFocalLength attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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).

function setFrontFocalLength¶

public void setFrontFocalLength(
    float value
)

Sets the value of the FrontFocalLength attribute.

Parameters:

value The value to set

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).

function getFrontFocalLength¶

public float getFrontFocalLength()

Returns the value of the FrontFocalLength attribute.

Return: The value of the 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).

function resetFrontFocalLength¶

public void 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).

function hasFrontFocalLength¶

public boolean hasFrontFocalLength()

Checks whether the FrontFocalLength attribute is present.

Return: true if the attribute has been set, false otherwise

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).

function setFrontFocalLengthUnit¶

public void setFrontFocalLengthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the FrontFocalLengthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setFrontFocalLengthUnit¶

public void setFrontFocalLengthUnit(
    UnitsLength_Type value
)

Sets the value of the FrontFocalLengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getFrontFocalLengthUnit¶

function resetFrontFocalLengthUnit¶

function hasFrontFocalLengthUnit¶

public boolean hasFrontFocalLengthUnit()

Checks whether the optional FrontFocalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setBackFocalLength¶

public void setBackFocalLength(
    float value,
    boolean validate
)

Sets the value of the BackFocalLength attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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').

function setBackFocalLength¶

public void setBackFocalLength(
    float value
)

Sets the value of the BackFocalLength attribute.

Parameters:

value The value to set

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').

function getBackFocalLength¶

public float getBackFocalLength()

Returns the value of the BackFocalLength attribute.

Return: The value of the 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').

function resetBackFocalLength¶

public void 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').

function hasBackFocalLength¶

public boolean hasBackFocalLength()

Checks whether the BackFocalLength attribute is present.

Return: true if the attribute has been set, false otherwise

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').

function setBackFocalLengthUnit¶

public void setBackFocalLengthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the BackFocalLengthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setBackFocalLengthUnit¶

public void setBackFocalLengthUnit(
    UnitsLength_Type value
)

Sets the value of the BackFocalLengthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getBackFocalLengthUnit¶

function resetBackFocalLengthUnit¶

function hasBackFocalLengthUnit¶

public boolean hasBackFocalLengthUnit()

Checks whether the optional BackFocalLengthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setRadiusOfCurvature¶

public void setRadiusOfCurvature(
    float value,
    boolean validate
)

Sets the value of the RadiusOfCurvature attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setRadiusOfCurvature¶

public void setRadiusOfCurvature(
    float value
)

Sets the value of the RadiusOfCurvature attribute.

Parameters:

value The value to set

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.

function getRadiusOfCurvature¶

public float getRadiusOfCurvature()

Returns the value of the RadiusOfCurvature attribute.

Return: The value of the 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.

function resetRadiusOfCurvature¶

public void 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.

function hasRadiusOfCurvature¶

public boolean hasRadiusOfCurvature()

Checks whether the RadiusOfCurvature attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setRadiusOfCurvatureUnit¶

public void setRadiusOfCurvatureUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the RadiusOfCurvatureUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setRadiusOfCurvatureUnit¶

public void setRadiusOfCurvatureUnit(
    UnitsLength_Type value
)

Sets the value of the RadiusOfCurvatureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getRadiusOfCurvatureUnit¶

function resetRadiusOfCurvatureUnit¶

function hasRadiusOfCurvatureUnit¶

public boolean hasRadiusOfCurvatureUnit()

Checks whether the optional RadiusOfCurvatureUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMaterialName¶

public void setMaterialName(
    OpticalMaterialName_Type value,
    boolean validate
)

Sets the value of the MaterialName attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setMaterialName¶

public void setMaterialName(
    OpticalMaterialName_Type value
)

Sets the value of the MaterialName attribute.

Parameters:

value The value to set

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

function getMaterialName¶

public OpticalMaterialName_Type getMaterialName()

Returns the value of the MaterialName attribute.

Return: The value of the attribute

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

function resetMaterialName¶

function hasMaterialName¶

public boolean hasMaterialName()

Checks whether the optional MaterialName attribute is present.

Return: true if the optional attribute has been set, false otherwise

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

function setGlassCode¶

public void setGlassCode(
    String value,
    boolean validate
)

Sets the value of the GlassCode attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function setGlassCode¶

public void setGlassCode(
    String value
)

Sets the value of the GlassCode attribute.

Parameters:

value The value to set

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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function getGlassCode¶

public String getGlassCode()

Returns the value of the GlassCode attribute.

Return: The value of the 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function resetGlassCode¶

public void 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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function hasGlassCode¶

public boolean hasGlassCode()

Checks whether the GlassCode attribute is present.

Return: true if the attribute has been set, false otherwise

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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function setRefractiveIndex¶

public void setRefractiveIndex(
    float value,
    boolean validate
)

Sets the value of the RefractiveIndex attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setRefractiveIndex¶

public void setRefractiveIndex(
    float value
)

Sets the value of the RefractiveIndex attribute.

Parameters:

value The value to set

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.

function getRefractiveIndex¶

public float getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

Return: The value of the 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.

function resetRefractiveIndex¶

public void 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.

function hasRefractiveIndex¶

public boolean hasRefractiveIndex()

Checks whether the RefractiveIndex attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setAbbeNumber¶

public void setAbbeNumber(
    float value,
    boolean validate
)

Sets the value of the AbbeNumber attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setAbbeNumber¶

public void setAbbeNumber(
    float value
)

Sets the value of the AbbeNumber attribute.

Parameters:

value The value to set

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.

function getAbbeNumber¶

public float getAbbeNumber()

Returns the value of the AbbeNumber attribute.

Return: The value of the 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.

function resetAbbeNumber¶

public void 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.

function hasAbbeNumber¶

public boolean hasAbbeNumber()

Checks whether the AbbeNumber attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setDensity¶

public void setDensity(
    float value,
    boolean validate
)

Sets the value of the Density attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setDensity¶

function getDensity¶

function resetDensity¶

function hasDensity¶

public boolean hasDensity()

Checks whether the Density attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setDensityUnit¶

public void setDensityUnit(
    UnitsDensity_Type value,
    boolean validate
)

Sets the value of the DensityUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setDensityUnit¶

function getDensityUnit¶

function resetDensityUnit¶

function hasDensityUnit¶

public boolean hasDensityUnit()

Checks whether the optional DensityUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setAnnotationRef¶

public void setAnnotationRef(
    AnnotationRef value,
    boolean validate
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAnnotationRef¶

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function __internal_create¶

public static Lens_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.__internal_create, com.inscoper.nbo.BeamExpanderLens.__internal_create, com.inscoper.nbo.CondenserLens.__internal_create, com.inscoper.nbo.CouplingLens.__internal_create, com.inscoper.nbo.GenericLens.__internal_create, com.inscoper.nbo.MagnificationChanger.__internal_create, com.inscoper.nbo.RelayLens.__internal_create, com.inscoper.nbo.TubeLens.__internal_create

function fromBase¶

public static Lens_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a Lens_Type.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromBase

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.fromBase, com.inscoper.nbo.BeamExpanderLens.fromBase, com.inscoper.nbo.CondenserLens.fromBase, com.inscoper.nbo.CouplingLens.fromBase, com.inscoper.nbo.GenericLens.fromBase, com.inscoper.nbo.MagnificationChanger.fromBase, com.inscoper.nbo.RelayLens.fromBase, com.inscoper.nbo.TubeLens.fromBase

function getCoatingAllowedValues¶

public static StringSet getCoatingAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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.

function getGlassCodeAllowedValues¶

public static StringSet getGlassCodeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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 = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

Protected Functions Documentation¶

function Lens_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.swigSetCMemOwn, com.inscoper.nbo.BeamExpanderLens.swigSetCMemOwn, com.inscoper.nbo.CondenserLens.swigSetCMemOwn, com.inscoper.nbo.CouplingLens.swigSetCMemOwn, com.inscoper.nbo.GenericLens.swigSetCMemOwn, com.inscoper.nbo.MagnificationChanger.swigSetCMemOwn, com.inscoper.nbo.RelayLens.swigSetCMemOwn, com.inscoper.nbo.TubeLens.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

Reimplemented by: com.inscoper.nbo.BeamCollimatorLens.finalize, com.inscoper.nbo.BeamExpanderLens.finalize, com.inscoper.nbo.CondenserLens.finalize, com.inscoper.nbo.CouplingLens.finalize, com.inscoper.nbo.GenericLens.finalize, com.inscoper.nbo.MagnificationChanger.finalize, com.inscoper.nbo.RelayLens.finalize, com.inscoper.nbo.TubeLens.finalize