com.inscoper.nbo.RelayLens¶

Represents the XML element RelayLens. More...

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

Public Functions¶

	Name
synchronized void	delete()
	RelayLens()
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.
RelayLens	__internal_create(long cPtr, boolean own)
RelayLens	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Lens_Type

	Name
	Lens_Type()
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.
StringSet	getCoatingAllowedValues() Returns the allowed values for this attribut.
StringSet	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.Lens_Type

	Name
	Lens_Type(long cPtr, boolean cMemoryOwn)

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.RelayLens;

Represents the XML element RelayLens.

A Relay Lens is often used in combination with other Lenses for transferring an Image into a different optical plane. A typical example of Relay Lens is the Lens positioned at the mount connecting a Detector with the Microscope Stand.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.Lens_Type.delete

function RelayLens¶

public RelayLens()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Lens_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.Lens_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.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.Lens_Type.toXmlString

function __internal_create¶

public static RelayLens __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.Lens_Type.__internal_create

function fromBase¶

public static RelayLens fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.Lens_Type.fromBase

Protected Functions Documentation¶

function RelayLens¶

protected RelayLens(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.Lens_Type.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.Lens_Type.finalize

function getCPtr¶

protected static long getCPtr(
    RelayLens obj
)

Updated on 2026-06-22 at 17:06:32 +0200