com.inscoper.nbo.MicroscopeStandSettings¶

Represents the XML element MicroscopeStandSettings. More...

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

Public Functions¶

	Name
synchronized void	delete()
	MicroscopeStandSettings()
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(MicroscopeID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(MicroscopeID_Type value) Sets the value of the ID attribute.
MicroscopeID_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	setTotalEffectiveMagnification(float value, boolean validate) Sets the value of the TotalEffectiveMagnification attribute.
void	setTotalEffectiveMagnification(float value) Sets the value of the TotalEffectiveMagnification attribute.
float	getTotalEffectiveMagnification() Returns the value of the TotalEffectiveMagnification attribute.
void	resetTotalEffectiveMagnification() Resets the TotalEffectiveMagnification attribute to an unset state.
boolean	hasTotalEffectiveMagnification() Checks whether the TotalEffectiveMagnification attribute is present.
void	setFieldOfView(float value, boolean validate) Sets the value of the FieldOfView attribute.
void	setFieldOfView(float value) Sets the value of the FieldOfView attribute.
float	getFieldOfView() Returns the value of the FieldOfView attribute.
void	resetFieldOfView() Resets the FieldOfView attribute to an unset state.
boolean	hasFieldOfView() Checks whether the FieldOfView attribute is present.
void	setFieldOfViewUnit(UnitsLength_Type value, boolean validate) Sets the value of the FieldOfViewUnit attribute.
void	setFieldOfViewUnit(UnitsLength_Type value) Sets the value of the FieldOfViewUnit attribute.
UnitsLength_Type	getFieldOfViewUnit() Returns the value of the FieldOfViewUnit attribute.
void	resetFieldOfViewUnit() Resets the FieldOfViewUnit attribute to an unset state.
boolean	hasFieldOfViewUnit() Checks whether the optional FieldOfViewUnit attribute is present.
MicroscopeStandSettings	__internal_create(long cPtr, boolean own)
MicroscopeStandSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a MicroscopeStandSettings.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
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	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.

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

Represents the XML element MicroscopeStandSettings.

This element refers to the Microscope Stand used to acquire this Image and it holds the Settings that were applied to the Microscope Stand during this Acquisition.

Public Functions Documentation¶

function delete¶

function MicroscopeStandSettings¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

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

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

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

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

function toXmlString¶

function setID¶

public void setID(
    MicroscopeID_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.

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

function setID¶

function getID¶

function resetID¶

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 Microscope used in this case.

function setTotalEffectiveMagnification¶

public void setTotalEffectiveMagnification(
    float value,
    boolean validate
)

Sets the value of the TotalEffectiveMagnification attribute.

Parameters:

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