com.inscoper.nbo.MicrolensArray

Represents the XML element MicrolensArray. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	MicrolensArray()
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) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(ElectroOpticalDeviceID_Type value) Sets the value of the ID attribute.
ElectroOpticalDeviceID_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) 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	setLensletDiameter(float value) Sets the value of the LensletDiameter attribute.
float	getLensletDiameter() Returns the value of the LensletDiameter attribute.
void	resetLensletDiameter() Resets the LensletDiameter attribute to an unset state.
boolean	hasLensletDiameter() Checks whether the optional LensletDiameter attribute is present.
void	setLensletDiameterUnit(UnitsLength_Type value) Sets the value of the LensletDiameterUnit attribute.
UnitsLength_Type	getLensletDiameterUnit() Returns the value of the LensletDiameterUnit attribute.
void	resetLensletDiameterUnit() Resets the LensletDiameterUnit attribute to an unset state.
boolean	hasLensletDiameterUnit() Checks whether the optional LensletDiameterUnit attribute is present.
void	setLensletPitch(float value) Sets the value of the LensletPitch attribute.
float	getLensletPitch() Returns the value of the LensletPitch attribute.
void	resetLensletPitch() Resets the LensletPitch attribute to an unset state.
boolean	hasLensletPitch() Checks whether the optional LensletPitch attribute is present.
void	setLensletPitchUnit(UnitsLength_Type value) Sets the value of the LensletPitchUnit attribute.
UnitsLength_Type	getLensletPitchUnit() Returns the value of the LensletPitchUnit attribute.
void	resetLensletPitchUnit() Resets the LensletPitchUnit attribute to an unset state.
boolean	hasLensletPitchUnit() Checks whether the optional LensletPitchUnit attribute is present.
void	setLensletArrangement(String value) Sets the value of the LensletArrangement attribute.
String	getLensletArrangement() Returns the value of the LensletArrangement attribute.
void	resetLensletArrangement() Resets the LensletArrangement attribute to an unset state.
boolean	hasLensletArrangement() Checks whether the optional LensletArrangement attribute is present.
void	setLensletShape(LensletShape_Type value) Sets the value of the LensletShape attribute.
LensletShape_Type	getLensletShape() Returns the value of the LensletShape attribute.
void	resetLensletShape() Resets the LensletShape attribute to an unset state.
boolean	hasLensletShape() Checks whether the optional LensletShape attribute is present.
void	setLensletProfileShape(LensShapeType_Type value) Sets the value of the LensletProfileShape attribute.
LensShapeType_Type	getLensletProfileShape() Returns the value of the LensletProfileShape attribute.
void	resetLensletProfileShape() Resets the LensletProfileShape attribute to an unset state.
boolean	hasLensletProfileShape() Checks whether the optional LensletProfileShape attribute is present.
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 optional Coating attribute is present.
void	setReflectance(float value) Sets the value of the Reflectance attribute.
float	getReflectance() Returns the value of the Reflectance attribute.
void	setSustrateMaterial(OpticalMaterialName_Type value) Sets the value of the SustrateMaterial attribute.
OpticalMaterialName_Type	getSustrateMaterial() Returns the value of the SustrateMaterial attribute.
void	resetSustrateMaterial() Resets the SustrateMaterial attribute to an unset state.
boolean	hasSustrateMaterial() Checks whether the optional SustrateMaterial attribute is present.
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 optional FrontFocalLength attribute is present.
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 optional BackFocalLength attribute is present.
void	setOpticalDistanceUnit(UnitsLength_Type value) Sets the value of the OpticalDistanceUnit attribute.
UnitsLength_Type	getOpticalDistanceUnit() Returns the value of the OpticalDistanceUnit attribute.
void	resetOpticalDistanceUnit() Resets the OpticalDistanceUnit attribute to an unset state.
boolean	hasOpticalDistanceUnit() Checks whether the optional OpticalDistanceUnit attribute is present.
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.
void	setWavelengthRange_List(WavelengthRangeVector value) Sets the list of WavelengthRange elements.
WavelengthRangeVector	getWavelengthRange_List() Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(WavelengthRange value) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.
MicrolensArray	__internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.MicrolensArray;

Represents the XML element MicrolensArray.

Micro-lens arrays contain multiple micro-lenses forming a one- or two-dimensional array on a supporting substrate.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function MicrolensArray

public MicrolensArray()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.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.NBOBaseClass.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.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    ElectroOpticalDeviceID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID

public ElectroOpticalDeviceID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

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

A Unique Identifier for this component.

function setName

public void setName(
    Denomination_Type value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A User-defined Name for this component.

function getName

public Denomination_Type getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A User-defined Name for this component.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

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

A User-defined Name for this component.

function setLensletDiameter

public void setLensletDiameter(
    float value
)

Sets the value of the LensletDiameter attribute.

Parameters:

value The value to set

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

function getLensletDiameter

public float getLensletDiameter()

Returns the value of the LensletDiameter attribute.

Return: The value of the attribute

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

function resetLensletDiameter

public void resetLensletDiameter()

Resets the LensletDiameter attribute to an unset state.

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

function hasLensletDiameter

public boolean hasLensletDiameter()

Checks whether the optional LensletDiameter attribute is present.

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

This field records the physical Dameter of the Lenslets that compose this Micro Lens Array.

function setLensletDiameterUnit

public void setLensletDiameterUnit(
    UnitsLength_Type value
)

Sets the value of the LensletDiameterUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getLensletDiameterUnit

public UnitsLength_Type getLensletDiameterUnit()

Returns the value of the LensletDiameterUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetLensletDiameterUnit

public void resetLensletDiameterUnit()

Resets the LensletDiameterUnit attribute to an unset state.

No description available in the XSD standard.

function hasLensletDiameterUnit

public boolean hasLensletDiameterUnit()

Checks whether the optional LensletDiameterUnit attribute is present.

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

No description available in the XSD standard.

function setLensletPitch

public void setLensletPitch(
    float value
)

Sets the value of the LensletPitch attribute.

Parameters:

value The value to set

This field records the distance between Lenslets in this Micro Lens Array.

function getLensletPitch

public float getLensletPitch()

Returns the value of the LensletPitch attribute.

Return: The value of the attribute

This field records the distance between Lenslets in this Micro Lens Array.

function resetLensletPitch

public void resetLensletPitch()

Resets the LensletPitch attribute to an unset state.

This field records the distance between Lenslets in this Micro Lens Array.

function hasLensletPitch

public boolean hasLensletPitch()

Checks whether the optional LensletPitch attribute is present.

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

This field records the distance between Lenslets in this Micro Lens Array.

function setLensletPitchUnit

public void setLensletPitchUnit(
    UnitsLength_Type value
)

Sets the value of the LensletPitchUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getLensletPitchUnit

public UnitsLength_Type getLensletPitchUnit()

Returns the value of the LensletPitchUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetLensletPitchUnit

public void resetLensletPitchUnit()

Resets the LensletPitchUnit attribute to an unset state.

No description available in the XSD standard.

function hasLensletPitchUnit

public boolean hasLensletPitchUnit()

Checks whether the optional LensletPitchUnit attribute is present.

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

No description available in the XSD standard.

function setLensletArrangement

public void setLensletArrangement(
    String value
)

Sets the value of the LensletArrangement attribute.

Parameters:

value The value to set

This field records the arrangement of individual Lenslets on this Array.

function getLensletArrangement

public String getLensletArrangement()

Returns the value of the LensletArrangement attribute.

Return: The value of the attribute

This field records the arrangement of individual Lenslets on this Array.

function resetLensletArrangement

public void resetLensletArrangement()

Resets the LensletArrangement attribute to an unset state.

This field records the arrangement of individual Lenslets on this Array.

function hasLensletArrangement

public boolean hasLensletArrangement()

Checks whether the optional LensletArrangement attribute is present.

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

This field records the arrangement of individual Lenslets on this Array.

function setLensletShape

public void setLensletShape(
    LensletShape_Type value
)

Sets the value of the LensletShape attribute.

Parameters:

value The value to set

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

function getLensletShape

public LensletShape_Type getLensletShape()

Returns the value of the LensletShape attribute.

Return: The value of the attribute

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

function resetLensletShape

public void resetLensletShape()

Resets the LensletShape attribute to an unset state.

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

function hasLensletShape

public boolean hasLensletShape()

Checks whether the optional LensletShape attribute is present.

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

This field records the geometrical shape (e.g., round vs. square) of the individual Lenslets composing this Micro Lens Array.

function setLensletProfileShape

public void setLensletProfileShape(
    LensShapeType_Type value
)

Sets the value of the LensletProfileShape attribute.

Parameters:

value The value to set

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

function getLensletProfileShape

public LensShapeType_Type getLensletProfileShape()

Returns the value of the LensletProfileShape attribute.

Return: The value of the attribute

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

function resetLensletProfileShape

public void resetLensletProfileShape()

Resets the LensletProfileShape attribute to an unset state.

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

function hasLensletProfileShape

public boolean hasLensletProfileShape()

Checks whether the optional LensletProfileShape attribute is present.

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

This field describes the shape of the profile (e.g., concave vs. convex) of the individual Lenslets that compose this Micro Lens Array.

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 thin-film material used to coat the non linear crystal and reduce surface reflection.

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 thin-film material used to coat the non linear crystal and reduce surface reflection.

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 thin-film material used to coat the non linear crystal and reduce surface reflection.

function hasCoating

public boolean hasCoating()

Checks whether the optional Coating attribute is present.

Return: true if the optional 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 thin-film material used to coat the non linear crystal and reduce surface reflection.

function setReflectance

public void setReflectance(
    float value
)

Sets the value of the Reflectance attribute.

Parameters:

value The value to set

This field records the maximum amount of light this Micro Lens Array is capable of reflecting. It is represented as a fractional value from 0.0 to 1.0.

function getReflectance

public float getReflectance()

Returns the value of the Reflectance attribute.

Return: The value of the attribute

This field records the maximum amount of light this Micro Lens Array is capable of reflecting. It is represented as a fractional value from 0.0 to 1.0.

function setSustrateMaterial

public void setSustrateMaterial(
    OpticalMaterialName_Type value
)

Sets the value of the SustrateMaterial attribute.

Parameters:

value The value to set

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

function getSustrateMaterial

public OpticalMaterialName_Type getSustrateMaterial()

Returns the value of the SustrateMaterial attribute.

Return: The value of the attribute

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

function resetSustrateMaterial

public void resetSustrateMaterial()

Resets the SustrateMaterial attribute to an unset state.

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

function hasSustrateMaterial

public boolean hasSustrateMaterial()

Checks whether the optional SustrateMaterial attribute is present.

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

This field records the chemical composition or designation of the substrate of this Micro Lens Array. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica.

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 Micro Lens Array 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 Micro Lens Array 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 Micro Lens Array to the front focal plane (F).

function hasFrontFocalLength

public boolean hasFrontFocalLength()

Checks whether the optional FrontFocalLength attribute is present.

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

This field records the distance (f) measured along the optical axis from the front principal plane of this Micro Lens Array to the front 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 Micro Lens Array 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 Micro Lens Array 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 Micro Lens Array to the rear focal plane (F').

function hasBackFocalLength

public boolean hasBackFocalLength()

Checks whether the optional BackFocalLength attribute is present.

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

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

function setOpticalDistanceUnit

public void setOpticalDistanceUnit(
    UnitsLength_Type value
)

Sets the value of the OpticalDistanceUnit attribute.

Parameters:

value The value to set

Use this unit for both Focal Length fields.

function getOpticalDistanceUnit

public UnitsLength_Type getOpticalDistanceUnit()

Returns the value of the OpticalDistanceUnit attribute.

Return: The value of the attribute

Use this unit for both Focal Length fields.

function resetOpticalDistanceUnit

public void resetOpticalDistanceUnit()

Resets the OpticalDistanceUnit attribute to an unset state.

Use this unit for both Focal Length fields.

function hasOpticalDistanceUnit

public boolean hasOpticalDistanceUnit()

Checks whether the optional OpticalDistanceUnit attribute is present.

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

Use this unit for both Focal Length fields.

function setAnnotationRef

public void setAnnotationRef(
    AnnotationRef value
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getAnnotationRef

public AnnotationRef getAnnotationRef()

Returns the value of the AnnotationRef element.

Return: The value of the element

No description available in the XSD standard.

function resetAnnotationRef

public void resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

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 setWavelengthRange_List

public void setWavelengthRange_List(
    WavelengthRangeVector value
)

Sets the list of WavelengthRange elements.

Parameters:

value The new list of WavelengthRange elements

No description available in the XSD standard.

function getWavelengthRange_List

public WavelengthRangeVector getWavelengthRange_List()

Returns the list of WavelengthRange elements.

Return: The list of WavelengthRange elements

No description available in the XSD standard.

function addToWavelengthRange_List

public void addToWavelengthRange_List(
    WavelengthRange value
)

Adds a new WavelengthRange element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearWavelengthRange_List

public void clearWavelengthRange_List()

Clear the list of WavelengthRange.

No description available in the XSD standard.

function __internal_create

public static MicrolensArray __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function MicrolensArray

protected MicrolensArray(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    MicrolensArray obj
)

Updated on 2026-02-13 at 16:11:04 +0100