com.inscoper.nbo.LensSettings

Represents the XML element LensSettings. More...

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

Public Functions

	Name
synchronized void	delete()
	LensSettings()
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(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	setFunction(String value) Sets the value of the Function attribute.
String	getFunction() Returns the value of the Function attribute.
LensSettings	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	LensSettings(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(LensSettings 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.LensSettings;

Represents the XML element LensSettings.

This element holds the Setting applied to a Lens used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Lens in question.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.Settings_Type.delete

function LensSettings

public LensSettings()

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(
    LensID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

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

function getID

public LensID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

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

function resetID

public void resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device 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 device used in this case.

function setFunction

public void setFunction(
    String value
)

Sets the value of the Function attribute.

Parameters:

value The value to set

This field records the purpose for which this Additinal Lens was used during the Acquisition of this Channel.

function getFunction

public String getFunction()

Returns the value of the Function attribute.

Return: The value of the attribute

This field records the purpose for which this Additinal Lens was used during the Acquisition of this Channel.

function __internal_create

public static LensSettings __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.Settings_Type.__internal_create

Protected Functions Documentation

function LensSettings

protected LensSettings(
    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(
    LensSettings obj
)

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