com.inscoper.nbo.ObjectiveSettings

Represents the XML element ObjectiveSettings. More...

Inherits from com.inscoper.nbo.Settings_Type, com.inscoper.nbo.Reference_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	ObjectiveSettings()
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(ObjectiveID_Type value) Sets the value of the ID attribute.
ObjectiveID_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	setCorrectionCollarPosition(String value) Sets the value of the CorrectionCollarPosition attribute.
String	getCorrectionCollarPosition() Returns the value of the CorrectionCollarPosition attribute.
void	resetCorrectionCollarPosition() Resets the CorrectionCollarPosition attribute to an unset state.
boolean	hasCorrectionCollarPosition() Checks whether the optional CorrectionCollarPosition attribute is present.
void	setNumericalApertureSetting(String value) Sets the value of the NumericalApertureSetting attribute.
String	getNumericalApertureSetting() Returns the value of the NumericalApertureSetting attribute.
void	resetNumericalApertureSetting() Resets the NumericalApertureSetting attribute to an unset state.
boolean	hasNumericalApertureSetting() Checks whether the optional NumericalApertureSetting attribute is present.
void	setMeasuredRefractiveIndex(float value) Sets the value of the MeasuredRefractiveIndex attribute.
float	getMeasuredRefractiveIndex() Returns the value of the MeasuredRefractiveIndex attribute.
void	resetMeasuredRefractiveIndex() Resets the MeasuredRefractiveIndex attribute to an unset state.
boolean	hasMeasuredRefractiveIndex() Checks whether the optional MeasuredRefractiveIndex attribute is present.
void	setTemperature(float value) Sets the value of the Temperature attribute.
float	getTemperature() Returns the value of the Temperature attribute.
void	resetTemperature() Resets the Temperature attribute to an unset state.
boolean	hasTemperature() Checks whether the optional Temperature attribute is present.
void	setTemperatureUnit(UnitsTemperature_Type value) Sets the value of the TemperatureUnit attribute.
UnitsTemperature_Type	getTemperatureUnit() Returns the value of the TemperatureUnit attribute.
void	resetTemperatureUnit() Resets the TemperatureUnit attribute to an unset state.
boolean	hasTemperatureUnit() Checks whether the optional TemperatureUnit attribute is present.
void	setIrisAperture(float value) Sets the value of the IrisAperture attribute.
float	getIrisAperture() Returns the value of the IrisAperture attribute.
void	resetIrisAperture() Resets the IrisAperture attribute to an unset state.
boolean	hasIrisAperture() Checks whether the optional IrisAperture attribute is present.
void	setImmersionLiquid(ImmersionLiquid value) Sets the value of the ImmersionLiquid element.
ImmersionLiquid	getImmersionLiquid() Returns the value of the ImmersionLiquid element.
void	resetImmersionLiquid() Resets the ImmersionLiquid element to an unset state.
boolean	hasImmersionLiquid() Checks whether the optional ImmersionLiquid element is present.
ObjectiveSettings	__internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
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) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
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) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type()

Protected Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_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.ObjectiveSettings;

Represents the XML element ObjectiveSettings.

This element holds the Setting applied to the Objective used during the Acquisition of this Image as well as a reference (the ID attribute) to the Objective in question.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.Settings_Type.delete

function ObjectiveSettings

public ObjectiveSettings()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Settings_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.Settings_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

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

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.Settings_Type.fromJsonFile

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.Settings_Type.fromJsonString

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.Settings_Type.fromXmlFile

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.Settings_Type.fromXmlString

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.Settings_Type.toXmlFile

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.Settings_Type.toXmlString

function setID

public void setID(
    ObjectiveID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

This is the Unique Identifier of the Objective used in this case.

function getID

public ObjectiveID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

This is the Unique Identifier of the Objective used in this case.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the Objective used in this case.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

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

This is the Unique Identifier of the Objective used in this case.

function setCorrectionCollarPosition

public void setCorrectionCollarPosition(
    String value
)

Sets the value of the CorrectionCollarPosition attribute.

Parameters:

value The value to set

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

function getCorrectionCollarPosition

public String getCorrectionCollarPosition()

Returns the value of the CorrectionCollarPosition attribute.

Return: The value of the attribute

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

function resetCorrectionCollarPosition

public void resetCorrectionCollarPosition()

Resets the CorrectionCollarPosition attribute to an unset state.

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

function hasCorrectionCollarPosition

public boolean hasCorrectionCollarPosition()

Checks whether the optional CorrectionCollarPosition attribute is present.

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

The Correction Collar typically consists of an adjustable ring on the Objective whose position can be modified. This field records the position of the collar during the Acquisition of this Image. Each correction collar has an arbitrary scale or it might be scale-less and instead have fixed positions with qualitative designations (i.e., Oil, Water in case in which the Objective might be corrected for Immersion Liquid).

function setNumericalApertureSetting

public void setNumericalApertureSetting(
    String value
)

Sets the value of the NumericalApertureSetting attribute.

Parameters:

value The value to set

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

function getNumericalApertureSetting

public String getNumericalApertureSetting()

Returns the value of the NumericalApertureSetting attribute.

Return: The value of the attribute

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

function resetNumericalApertureSetting

public void resetNumericalApertureSetting()

Resets the NumericalApertureSetting attribute to an unset state.

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

function hasNumericalApertureSetting

public boolean hasNumericalApertureSetting()

Checks whether the optional NumericalApertureSetting attribute is present.

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

In case the Numerical Aperture (NA) of this Objective is variable (i.e., as for example in case of Objectives that can be used with or without Cover Glass or Objectives that can be dipped in different media), this field capture the NA setting that was employed for Image Acquisition. NOTE: please note that often NA regulation in these types of Objectives occurs via a rotating collar whose exact position is difficult to measure and reproduce across different Experiments.

function setMeasuredRefractiveIndex

public void setMeasuredRefractiveIndex(
    float value
)

Sets the value of the MeasuredRefractiveIndex attribute.

Parameters:

value The value to set

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

function getMeasuredRefractiveIndex

public float getMeasuredRefractiveIndex()

Returns the value of the MeasuredRefractiveIndex attribute.

Return: The value of the attribute

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

function resetMeasuredRefractiveIndex

public void resetMeasuredRefractiveIndex()

Resets the MeasuredRefractiveIndex attribute to an unset state.

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

function hasMeasuredRefractiveIndex

public boolean hasMeasuredRefractiveIndex()

Checks whether the optional MeasuredRefractiveIndex attribute is present.

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

The field records the Temperature dependent measured Refractive Index of the Immersion Liquid (or Dipping Medium) utilized in this case.

function setTemperature

public void setTemperature(
    float value
)

Sets the value of the Temperature attribute.

Parameters:

value The value to set

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

function getTemperature

public float getTemperature()

Returns the value of the Temperature attribute.

Return: The value of the attribute

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

function resetTemperature

public void resetTemperature()

Resets the Temperature attribute to an unset state.

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

function hasTemperature

public boolean hasTemperature()

Checks whether the optional Temperature attribute is present.

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

This field captures the Temperature of the Objective if different from the ImagingEnvironment/Temperature.

function setTemperatureUnit

public void setTemperatureUnit(
    UnitsTemperature_Type value
)

Sets the value of the TemperatureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTemperatureUnit

public UnitsTemperature_Type getTemperatureUnit()

Returns the value of the TemperatureUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTemperatureUnit

public void resetTemperatureUnit()

Resets the TemperatureUnit attribute to an unset state.

No description available in the XSD standard.

function hasTemperatureUnit

public boolean hasTemperatureUnit()

Checks whether the optional TemperatureUnit attribute is present.

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

No description available in the XSD standard.

function setIrisAperture

public void setIrisAperture(
    float value
)

Sets the value of the IrisAperture attribute.

Parameters:

value The value to set

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

function getIrisAperture

public float getIrisAperture()

Returns the value of the IrisAperture attribute.

Return: The value of the attribute

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

function resetIrisAperture

public void resetIrisAperture()

Resets the IrisAperture attribute to an unset state.

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

function hasIrisAperture

public boolean hasIrisAperture()

Checks whether the optional IrisAperture attribute is present.

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

This field records the aperture of the Iris diaphragm, which determines the size of the objective rear aperture yielding a variable numerical aperture range between 0.5 and the objective's upper limit.

function setImmersionLiquid

public void setImmersionLiquid(
    ImmersionLiquid value
)

Sets the value of the ImmersionLiquid element.

Parameters:

value The value to set

No description available in the XSD standard.

function getImmersionLiquid

public ImmersionLiquid getImmersionLiquid()

Returns the value of the ImmersionLiquid element.

Return: The value of the element

No description available in the XSD standard.

function resetImmersionLiquid

public void resetImmersionLiquid()

Resets the ImmersionLiquid element to an unset state.

No description available in the XSD standard.

function hasImmersionLiquid

public boolean hasImmersionLiquid()

Checks whether the optional ImmersionLiquid 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 ObjectiveSettings __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.__internal_create

Protected Functions Documentation

function ObjectiveSettings

protected ObjectiveSettings(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.Settings_Type.finalize

function getCPtr

protected static long getCPtr(
    ObjectiveSettings obj
)

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