Inscoper::NBO::ImagingEnvironment¶

Represents the XML element ImagingEnvironment. More...

#include <ImagingEnvironment.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	ImagingEnvironment()
	~ImagingEnvironment()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::EnvironmentalControlDeviceID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
EnvironmentalControlDeviceID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setTemperature(const std::string & value, bool validate =true) Sets the value of the Temperature attribute.
std::string	getTemperature() const Returns the value of the Temperature attribute.
void	resetTemperature() Resets the Temperature attribute to an unset state.
bool	hasTemperature() const Checks whether the Temperature attribute is present.
void	setTemperatureUnit(const Inscoper::NBO::UnitsTemperature_TypePtr & value, bool validate =true) Sets the value of the TemperatureUnit attribute.
UnitsTemperature_TypePtr	getTemperatureUnit() const Returns the value of the TemperatureUnit attribute.
void	resetTemperatureUnit() Resets the TemperatureUnit attribute to an unset state.
bool	hasTemperatureUnit() const Checks whether the optional TemperatureUnit attribute is present.
void	setCO2Percent(const std::string & value, bool validate =true) Sets the value of the CO2Percent attribute.
std::string	getCO2Percent() const Returns the value of the CO2Percent attribute.
void	resetCO2Percent() Resets the CO2Percent attribute to an unset state.
bool	hasCO2Percent() const Checks whether the CO2Percent attribute is present.
void	setHumidity(const std::string & value, bool validate =true) Sets the value of the Humidity attribute.
std::string	getHumidity() const Returns the value of the Humidity attribute.
void	resetHumidity() Resets the Humidity attribute to an unset state.
bool	hasHumidity() const Checks whether the Humidity attribute is present.
void	setAirPressure(const float & value, bool validate =true) Sets the value of the AirPressure attribute.
float	getAirPressure() const Returns the value of the AirPressure attribute.
void	resetAirPressure() Resets the AirPressure attribute to an unset state.
bool	hasAirPressure() const Checks whether the AirPressure attribute is present.
void	setAirPressureUnit(const Inscoper::NBO::UnitsPressure_TypePtr & value, bool validate =true) Sets the value of the AirPressureUnit attribute.
UnitsPressure_TypePtr	getAirPressureUnit() const Returns the value of the AirPressureUnit attribute.
void	resetAirPressureUnit() Resets the AirPressureUnit attribute to an unset state.
bool	hasAirPressureUnit() const Checks whether the optional AirPressureUnit attribute is present.
void	setO2Percent(const Inscoper::NBO::PercentFraction_TypePtr & value, bool validate =true) Sets the value of the O2Percent attribute.
PercentFraction_TypePtr	getO2Percent() const Returns the value of the O2Percent attribute.
void	resetO2Percent() Resets the O2Percent attribute to an unset state.
bool	hasO2Percent() const Checks whether the optional O2Percent attribute is present.
void	setDescription(const Inscoper::NBO::DescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::DescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
void	setMap(const Inscoper::NBO::Map_TypePtr & value, bool validate =true) Sets the value of the Map element.
Inscoper::NBO::Map_TypePtr	getMap() const Returns the value of the Map element.
void	resetMap() Resets the Map element to an unset state.
bool	hasMap() const Checks whether the optional Map element is present.
std::shared_ptr< ImagingEnvironment >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a ImagingEnvironment.
const std::set< std::string > &	getTemperatureAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCO2PercentAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getHumidityAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class 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 ImagingEnvironment¶

function ~ImagingEnvironment¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

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

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

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

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

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

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

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

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

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

std::string toXmlString(
    bool validate =true
) const

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

void setID(
    const Inscoper::NBO::EnvironmentalControlDeviceID_TypePtr & value,
    bool validate =true
)

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

EnvironmentalControlDeviceID_TypePtr getID() const

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¶

bool hasID() const

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¶

void setTemperature(
    const std::string & value,
    bool validate =true
)

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

std::string getTemperature() const

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¶

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¶

bool hasTemperature() const

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¶

void setTemperatureUnit(
    const Inscoper::NBO::UnitsTemperature_TypePtr & value,
    bool validate =true
)

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

function resetTemperatureUnit¶

function hasTemperatureUnit¶

bool hasTemperatureUnit() const

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¶

void setCO2Percent(
    const std::string & value,
    bool validate =true
)

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

std::string getCO2Percent() const

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¶

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¶

bool hasCO2Percent() const

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¶

void setHumidity(
    const std::string & value,
    bool validate =true
)

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

std::string getHumidity() const

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¶

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¶

bool hasHumidity() const

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¶

void setAirPressure(
    const float & value,
    bool validate =true
)

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

function resetAirPressure¶

function hasAirPressure¶

bool hasAirPressure() const

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¶

void setAirPressureUnit(
    const Inscoper::NBO::UnitsPressure_TypePtr & value,
    bool validate =true
)

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

function resetAirPressureUnit¶

function hasAirPressureUnit¶

bool hasAirPressureUnit() const

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¶

void setO2Percent(
    const Inscoper::NBO::PercentFraction_TypePtr & value,
    bool validate =true
)

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

PercentFraction_TypePtr getO2Percent() const

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¶

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¶

bool hasO2Percent() const

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¶

void setDescription(
    const Inscoper::NBO::DescriptionPtr & value,
    bool validate =true
)

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

function resetDescription¶

function hasDescription¶

bool hasDescription() const

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¶

void setMap(
    const Inscoper::NBO::Map_TypePtr & value,
    bool validate =true
)

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

function resetMap¶

function hasMap¶

function fromBase¶

static std::shared_ptr< ImagingEnvironment > fromBase(
    NBOBaseClassPtr 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¶

static const std::set< std::string > & 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¶

static const std::set< std::string > & 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¶

static const std::set< std::string > & 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".

Updated on 2026-09-23 at 16:50:38 +0200