com.inscoper.nbo.ImagingEnvironment¶

Represents the XML element ImagingEnvironment. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	ImagingEnvironment()
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(EnvironmentalControlDeviceID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(EnvironmentalControlDeviceID_Type value) Sets the value of the ID attribute.
EnvironmentalControlDeviceID_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	setTemperature(String value, boolean validate) Sets the value of the Temperature attribute.
void	setTemperature(String value) Sets the value of the Temperature attribute.
String	getTemperature() Returns the value of the Temperature attribute.
void	resetTemperature() Resets the Temperature attribute to an unset state.
boolean	hasTemperature() Checks whether the Temperature attribute is present.
void	setTemperatureUnit(UnitsTemperature_Type value, boolean validate) Sets the value of the TemperatureUnit attribute.
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	setCO2Percent(String value, boolean validate) Sets the value of the CO2Percent attribute.
void	setCO2Percent(String value) Sets the value of the CO2Percent attribute.
String	getCO2Percent() Returns the value of the CO2Percent attribute.
void	resetCO2Percent() Resets the CO2Percent attribute to an unset state.
boolean	hasCO2Percent() Checks whether the CO2Percent attribute is present.
void	setHumidity(String value, boolean validate) Sets the value of the Humidity attribute.
void	setHumidity(String value) Sets the value of the Humidity attribute.
String	getHumidity() Returns the value of the Humidity attribute.
void	resetHumidity() Resets the Humidity attribute to an unset state.
boolean	hasHumidity() Checks whether the Humidity attribute is present.
void	setAirPressure(float value, boolean validate) Sets the value of the AirPressure attribute.
void	setAirPressure(float value) Sets the value of the AirPressure attribute.
float	getAirPressure() Returns the value of the AirPressure attribute.
void	resetAirPressure() Resets the AirPressure attribute to an unset state.
boolean	hasAirPressure() Checks whether the AirPressure attribute is present.
void	setAirPressureUnit(UnitsPressure_Type value, boolean validate) Sets the value of the AirPressureUnit attribute.
void	setAirPressureUnit(UnitsPressure_Type value) Sets the value of the AirPressureUnit attribute.
UnitsPressure_Type	getAirPressureUnit() Returns the value of the AirPressureUnit attribute.
void	resetAirPressureUnit() Resets the AirPressureUnit attribute to an unset state.
boolean	hasAirPressureUnit() Checks whether the optional AirPressureUnit attribute is present.
void	setO2Percent(PercentFraction_Type value, boolean validate) Sets the value of the O2Percent attribute.
void	setO2Percent(PercentFraction_Type value) Sets the value of the O2Percent attribute.
PercentFraction_Type	getO2Percent() Returns the value of the O2Percent attribute.
void	resetO2Percent() Resets the O2Percent attribute to an unset state.
boolean	hasO2Percent() Checks whether the optional O2Percent attribute is present.
void	setDescription(Description value, boolean validate) Sets the value of the Description element.
void	setDescription(Description value) Sets the value of the Description element.
Description	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setMap(Map_Type value, boolean validate) Sets the value of the Map element.
void	setMap(Map_Type value) Sets the value of the Map element.
Map_Type	getMap() Returns the value of the Map element.
void	resetMap() Resets the Map element to an unset state.
boolean	hasMap() Checks whether the optional Map element is present.
ImagingEnvironment	__internal_create(long cPtr, boolean own)
ImagingEnvironment	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a ImagingEnvironment.
StringSet	getTemperatureAllowedValues() Returns the allowed values for this attribut.
StringSet	getCO2PercentAllowedValues() Returns the allowed values for this attribut.
StringSet	getHumidityAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Represents the XML element ImagingEnvironment.

This element describes the environment in which the biological sample was maintained during the Acquisition of this Image.

Public Functions Documentation¶

function delete¶

function ImagingEnvironment¶

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.NBOBaseClass.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.

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.

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

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.

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

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

function toXmlString¶

function setID¶

public void setID(
    EnvironmentalControlDeviceID_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 Environmental Control Device used in this case.

function setID¶

public void setID(
    EnvironmentalControlDeviceID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

This is the Unique Identifier of the Environmental Control Device used in this case.

function getID¶

public EnvironmentalControlDeviceID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

This is the Unique Identifier of the Environmental Control Device used in this case.

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 Environmental Control Device used in this case.

function setTemperature¶

public void setTemperature(
    String value,
    boolean validate
)

Sets the value of the Temperature attribute.

Parameters:

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

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function setTemperature¶

public void setTemperature(
    String value
)

Sets the value of the Temperature attribute.

Parameters:

value The value to set

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function getTemperature¶

public String getTemperature()

Returns the value of the Temperature attribute.

Return: The value of the attribute

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function resetTemperature¶

public void resetTemperature()

Resets the Temperature attribute to an unset state.

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function hasTemperature¶

public boolean hasTemperature()

Checks whether the Temperature attribute is present.

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

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function setTemperatureUnit¶

public void setTemperatureUnit(
    UnitsTemperature_Type value,
    boolean validate
)

Sets the value of the TemperatureUnit attribute.

Parameters:

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

No description available in the XSD standard.

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¶

function resetTemperatureUnit¶

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 setCO2Percent¶

public void setCO2Percent(
    String value,
    boolean validate
)

Sets the value of the CO2Percent attribute.

Parameters:

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

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function setCO2Percent¶

public void setCO2Percent(
    String value
)

Sets the value of the CO2Percent attribute.

Parameters:

value The value to set

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function getCO2Percent¶

public String getCO2Percent()

Returns the value of the CO2Percent attribute.

Return: The value of the attribute

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function resetCO2Percent¶

public void resetCO2Percent()

Resets the CO2Percent attribute to an unset state.

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function hasCO2Percent¶

public boolean hasCO2Percent()

Checks whether the CO2Percent attribute is present.

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

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function setHumidity¶

public void setHumidity(
    String value,
    boolean validate
)

Sets the value of the Humidity attribute.

Parameters:

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

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function setHumidity¶

public void setHumidity(
    String value
)

Sets the value of the Humidity attribute.

Parameters:

value The value to set

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function getHumidity¶

public String getHumidity()

Returns the value of the Humidity attribute.

Return: The value of the attribute

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function resetHumidity¶

public void resetHumidity()

Resets the Humidity attribute to an unset state.

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function hasHumidity¶

public boolean hasHumidity()

Checks whether the Humidity attribute is present.

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

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function setAirPressure¶

public void setAirPressure(
    float value,
    boolean validate
)

Sets the value of the AirPressure attribute.

Parameters:

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

The field records the AirPressure the Acquisition of this Image was performed at.

function setAirPressure¶

public void setAirPressure(
    float value
)

Sets the value of the AirPressure attribute.

Parameters:

value The value to set

The field records the AirPressure the Acquisition of this Image was performed at.

function getAirPressure¶

function resetAirPressure¶

function hasAirPressure¶

public boolean hasAirPressure()

Checks whether the AirPressure attribute is present.

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

The field records the AirPressure the Acquisition of this Image was performed at.

function setAirPressureUnit¶

public void setAirPressureUnit(
    UnitsPressure_Type value,
    boolean validate
)

Sets the value of the AirPressureUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setAirPressureUnit¶

function getAirPressureUnit¶

function resetAirPressureUnit¶

function hasAirPressureUnit¶

public boolean hasAirPressureUnit()

Checks whether the optional AirPressureUnit attribute is present.

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

No description available in the XSD standard.

function setO2Percent¶

public void setO2Percent(
    PercentFraction_Type value,
    boolean validate
)

Sets the value of the O2Percent attribute.

Parameters:

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

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function setO2Percent¶

public void setO2Percent(
    PercentFraction_Type value
)

Sets the value of the O2Percent attribute.

Parameters:

value The value to set

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function getO2Percent¶

public PercentFraction_Type getO2Percent()

Returns the value of the O2Percent attribute.

Return: The value of the attribute

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function resetO2Percent¶

public void resetO2Percent()

Resets the O2Percent attribute to an unset state.

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function hasO2Percent¶

public boolean hasO2Percent()

Checks whether the optional O2Percent attribute is present.

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

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function setDescription¶

public void setDescription(
    Description value,
    boolean validate
)

Sets the value of the Description element.

Parameters:

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

No description available in the XSD standard.

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

public boolean hasDescription()

Checks whether the optional Description element is present.

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

No description available in the XSD standard.

function setMap¶

public void setMap(
    Map_Type value,
    boolean validate
)

Sets the value of the Map element.

Parameters:

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

This is a Mapping of Key/Value pairs.

function setMap¶

function getMap¶

function resetMap¶

function hasMap¶

function __internal_create¶

function fromBase¶

public static ImagingEnvironment fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a ImagingEnvironment.

Parameters:

base The base class to cast

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

function getTemperatureAllowedValues¶

public static StringSet getTemperatureAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function getCO2PercentAllowedValues¶

public static StringSet getCO2PercentAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function getHumidityAllowedValues¶

public static StringSet getHumidityAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".