ImagingEnvironment

Bases: NBOBaseClass

Represents the XML element ImagingEnvironment.

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

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
ImagingEnvironment	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value, validate=True)

Sets the value of the ID attribute.

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

Parameters:

Name	Type	Description	Default
value	EnvironmentalControlDeviceID_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getID()

Returns the value of the ID attribute.

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

Returns:

Type	Description
EnvironmentalControlDeviceID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

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

hasID()

Checks whether the optional ID attribute is present.

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

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setTemperature(value, validate=True)

Sets the value of the Temperature attribute.

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

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getTemperature()

Returns the value of the Temperature attribute.

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

Returns:

Type	Description
string	The value of the attribute

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

hasTemperature()

Checks whether the Temperature attribute is present.

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

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getTemperatureAllowedValues() staticmethod

Returns the allowed values for this attribut.

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

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setTemperatureUnit(value, validate=True)

Sets the value of the TemperatureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTemperature_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getTemperatureUnit()

Returns the value of the TemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetTemperatureUnit()

Resets the TemperatureUnit attribute to an unset state.

No description available in the XSD standard.

hasTemperatureUnit()

Checks whether the optional TemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setCO2Percent(value, validate=True)

Sets the value of the CO2Percent 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".

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getCO2Percent()

Returns the value of the CO2Percent 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".

Returns:

Type	Description
string	The value of the attribute

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

hasCO2Percent()

Checks whether the CO2Percent attribute is present.

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

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getCO2PercentAllowedValues() staticmethod

Returns the allowed values for this attribut.

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

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setHumidity(value, validate=True)

Sets the value of the Humidity 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".

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getHumidity()

Returns the value of the Humidity 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".

Returns:

Type	Description
string	The value of the attribute

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

hasHumidity()

Checks whether the Humidity attribute is present.

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

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getHumidityAllowedValues() staticmethod

Returns the allowed values for this attribut.

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

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setAirPressure(value, validate=True)

Sets the value of the AirPressure attribute.

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

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAirPressure()

Returns the value of the AirPressure attribute.

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

Returns:

Type	Description
float	The value of the attribute

resetAirPressure()

Resets the AirPressure attribute to an unset state.

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

hasAirPressure()

Checks whether the AirPressure attribute is present.

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

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

setAirPressureUnit(value, validate=True)

Sets the value of the AirPressureUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsPressure_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAirPressureUnit()

Returns the value of the AirPressureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsPressure_Type	The value of the attribute

resetAirPressureUnit()

Resets the AirPressureUnit attribute to an unset state.

No description available in the XSD standard.

hasAirPressureUnit()

Checks whether the optional AirPressureUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setO2Percent(value, validate=True)

Sets the value of the O2Percent 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.

Parameters:

Name	Type	Description	Default
value	PercentFraction_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getO2Percent()

Returns the value of the O2Percent 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.

Returns:

Type	Description
PercentFraction_Type	The value of the attribute

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.

hasO2Percent()

Checks whether the optional O2Percent attribute is present.

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.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDescription(value, validate=True)

Sets the value of the Description element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Description	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getDescription()

Returns the value of the Description element.

No description available in the XSD standard.

Returns:

Type	Description
Description	The value of the element

resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

hasDescription()

Checks whether the optional Description element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setMap(value, validate=True)

Sets the value of the Map element.

This is a Mapping of Key/Value pairs.

Parameters:

Name	Type	Description	Default
value	Map_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getMap()

Returns the value of the Map element.

This is a Mapping of Key/Value pairs.

Returns:

Type	Description
Map_Type	The value of the element

resetMap()

Resets the Map element to an unset state.

This is a Mapping of Key/Value pairs.

hasMap()

Checks whether the optional Map element is present.

This is a Mapping of Key/Value pairs.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise