EnvironmentalControlDevice

Bases: ManufacturerSpec_Type

Represents the XML element EnvironmentalControlDevice.

This element describes an Environmental Control Device available for this Instrument to maintain a controlled Imaging Environment during Imaging Environment.

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

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LSID_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.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value, validate=True)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

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

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setTemperatureControl(value, validate=True)

Sets the value of the TemperatureControl attribute.

This field captures whether this Environmental Control Device provides Temperature control and what type of control it provides. If no Temperature control is provided please enter "None".

Parameters:

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

getTemperatureControl()

Returns the value of the TemperatureControl attribute.

This field captures whether this Environmental Control Device provides Temperature control and what type of control it provides. If no Temperature control is provided please enter "None".

Returns:

Type	Description
EnvironmentalControlMethod_Type	The value of the attribute

resetTemperatureControl()

Resets the TemperatureControl attribute to an unset state.

This field captures whether this Environmental Control Device provides Temperature control and what type of control it provides. If no Temperature control is provided please enter "None".

hasTemperatureControl()

Checks whether the optional TemperatureControl attribute is present.

This field captures whether this Environmental Control Device provides Temperature control and what type of control it provides. If no Temperature control is provided please enter "None".

Returns:

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

setHumidityControl(value, validate=True)

Sets the value of the HumidityControl attribute.

This field captures whether this Environmental Control Device provides Humidity control and what type of control it provides. If no Humidity control is provided please enter None.

Parameters:

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

getHumidityControl()

Returns the value of the HumidityControl attribute.

This field captures whether this Environmental Control Device provides Humidity control and what type of control it provides. If no Humidity control is provided please enter None.

Returns:

Type	Description
HumidityControlMethod_Type	The value of the attribute

resetHumidityControl()

Resets the HumidityControl attribute to an unset state.

This field captures whether this Environmental Control Device provides Humidity control and what type of control it provides. If no Humidity control is provided please enter None.

hasHumidityControl()

Checks whether the optional HumidityControl attribute is present.

This field captures whether this Environmental Control Device provides Humidity control and what type of control it provides. If no Humidity control is provided please enter None.

Returns:

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

setCO2Control(value, validate=True)

Sets the value of the CO2Control attribute.

This field captures whether this Environmental Control Device provides CO2 control and what type of control it provides. If no CO2 control is provided please enter None.

Parameters:

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

getCO2Control()

Returns the value of the CO2Control attribute.

This field captures whether this Environmental Control Device provides CO2 control and what type of control it provides. If no CO2 control is provided please enter None.

Returns:

Type	Description
CO2ControlMethod_Type	The value of the attribute

resetCO2Control()

Resets the CO2Control attribute to an unset state.

This field captures whether this Environmental Control Device provides CO2 control and what type of control it provides. If no CO2 control is provided please enter None.

hasCO2Control()

Checks whether the optional CO2Control attribute is present.

This field captures whether this Environmental Control Device provides CO2 control and what type of control it provides. If no CO2 control is provided please enter None.

Returns:

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

setO2Control(value, validate=True)

Sets the value of the O2Control attribute.

This field captures whether (True) or not (False) this Environmental Control Device provides vibration control.

Parameters:

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

getO2Control()

Returns the value of the O2Control attribute.

This field captures whether (True) or not (False) this Environmental Control Device provides vibration control.

Returns:

Type	Description
boolean	The value of the attribute

resetO2Control()

Resets the O2Control attribute to an unset state.

This field captures whether (True) or not (False) this Environmental Control Device provides vibration control.

hasO2Control()

Checks whether the O2Control attribute is present.

This field captures whether (True) or not (False) this Environmental Control Device provides vibration control.

Returns:

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

setVibrationControl(value, validate=True)

Sets the value of the VibrationControl attribute.

This field captures whether (True) or not (False) this Environmental Control Device provides O2 control.

Parameters:

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

getVibrationControl()

Returns the value of the VibrationControl attribute.

This field captures whether (True) or not (False) this Environmental Control Device provides O2 control.

Returns:

Type	Description
boolean	The value of the attribute

resetVibrationControl()

Resets the VibrationControl attribute to an unset state.

This field captures whether (True) or not (False) this Environmental Control Device provides O2 control.

hasVibrationControl()

Checks whether the VibrationControl attribute is present.

This field captures whether (True) or not (False) this Environmental Control Device provides O2 control.

Returns:

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

setStandCompatibility(value, validate=True)

Sets the value of the StandCompatibility attribute.

This field captures what Microscope Stand type this Environmental Control Chamber is compatible with.

Parameters:

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

getStandCompatibility()

Returns the value of the StandCompatibility attribute.

This field captures what Microscope Stand type this Environmental Control Chamber is compatible with.

Returns:

Type	Description
EnvironmentalStandCompatibility_Type	The value of the attribute

resetStandCompatibility()

Resets the StandCompatibility attribute to an unset state.

This field captures what Microscope Stand type this Environmental Control Chamber is compatible with.

hasStandCompatibility()

Checks whether the optional StandCompatibility attribute is present.

This field captures what Microscope Stand type this Environmental Control Chamber is compatible with.

Returns:

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

setPerfusion(value, validate=True)

Sets the value of the Perfusion attribute.

This field caputers whether (True) or not (False) this Environmental Control Device supports sample Perfusion.

Parameters:

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

getPerfusion()

Returns the value of the Perfusion attribute.

This field caputers whether (True) or not (False) this Environmental Control Device supports sample Perfusion.

Returns:

Type	Description
boolean	The value of the attribute

resetPerfusion()

Resets the Perfusion attribute to an unset state.

This field caputers whether (True) or not (False) this Environmental Control Device supports sample Perfusion.

hasPerfusion()

Checks whether the Perfusion attribute is present.

This field caputers whether (True) or not (False) this Environmental Control Device supports sample Perfusion.

Returns:

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

setLidMaterial(value, validate=True)

Sets the value of the LidMaterial attribute.

In case this Environmental Control Device consists of a Sample Holder Chamber, this field captures the Material that constitutes the Lid of the Chamber.

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

getLidMaterial()

Returns the value of the LidMaterial attribute.

In case this Environmental Control Device consists of a Sample Holder Chamber, this field captures the Material that constitutes the Lid of the Chamber.

Returns:

Type	Description
string	The value of the attribute

resetLidMaterial()

Resets the LidMaterial attribute to an unset state.

In case this Environmental Control Device consists of a Sample Holder Chamber, this field captures the Material that constitutes the Lid of the Chamber.

hasLidMaterial()

Checks whether the LidMaterial attribute is present.

In case this Environmental Control Device consists of a Sample Holder Chamber, this field captures the Material that constitutes the Lid of the Chamber.

Returns:

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

getLidMaterialAllowedValues() staticmethod

Returns the allowed values for this attribut.

In case this Environmental Control Device consists of a Sample Holder Chamber, this field captures the Material that constitutes the Lid of the Chamber.

Returns:

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

setMaxTemperature(value, validate=True)

Sets the value of the MaxTemperature attribute.

This field captures the Maximum Temperature that can be stably maintained by this Environmental Control Device.

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

getMaxTemperature()

Returns the value of the MaxTemperature attribute.

This field captures the Maximum Temperature that can be stably maintained by this Environmental Control Device.

Returns:

Type	Description
float	The value of the attribute

resetMaxTemperature()

Resets the MaxTemperature attribute to an unset state.

This field captures the Maximum Temperature that can be stably maintained by this Environmental Control Device.

hasMaxTemperature()

Checks whether the MaxTemperature attribute is present.

This field captures the Maximum Temperature that can be stably maintained by this Environmental Control Device.

Returns:

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

setMaxTemperatureUnit(value, validate=True)

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

getMaxTemperatureUnit()

Returns the value of the MaxTemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetMaxTemperatureUnit()

Resets the MaxTemperatureUnit attribute to an unset state.

No description available in the XSD standard.

hasMaxTemperatureUnit()

Checks whether the optional MaxTemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setMinTemberature(value, validate=True)

Sets the value of the MinTemberature attribute.

This field captures the Minimum Temperature that can be stably maintained by this Environmental Control Device.

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

getMinTemberature()

Returns the value of the MinTemberature attribute.

This field captures the Minimum Temperature that can be stably maintained by this Environmental Control Device.

Returns:

Type	Description
float	The value of the attribute

resetMinTemberature()

Resets the MinTemberature attribute to an unset state.

This field captures the Minimum Temperature that can be stably maintained by this Environmental Control Device.

hasMinTemberature()

Checks whether the MinTemberature attribute is present.

This field captures the Minimum Temperature that can be stably maintained by this Environmental Control Device.

Returns:

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

setMinTemperatureUnit(value, validate=True)

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

getMinTemperatureUnit()

Returns the value of the MinTemperatureUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetMinTemperatureUnit()

Resets the MinTemperatureUnit attribute to an unset state.

No description available in the XSD standard.

hasMinTemperatureUnit()

Checks whether the optional MinTemperatureUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTemperatureAccuracy(value, validate=True)

Sets the value of the TemperatureAccuracy attribute.

This field captures the Temperature control Accuracy provided by this Environmental Control Device.

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

getTemperatureAccuracy()

Returns the value of the TemperatureAccuracy attribute.

This field captures the Temperature control Accuracy provided by this Environmental Control Device.

Returns:

Type	Description
float	The value of the attribute

resetTemperatureAccuracy()

Resets the TemperatureAccuracy attribute to an unset state.

This field captures the Temperature control Accuracy provided by this Environmental Control Device.

hasTemperatureAccuracy()

Checks whether the TemperatureAccuracy attribute is present.

This field captures the Temperature control Accuracy provided by this Environmental Control Device.

Returns:

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

setTemperatureAccuracyUnit(value, validate=True)

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

getTemperatureAccuracyUnit()

Returns the value of the TemperatureAccuracyUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTemperature_Type	The value of the attribute

resetTemperatureAccuracyUnit()

Resets the TemperatureAccuracyUnit attribute to an unset state.

No description available in the XSD standard.

hasTemperatureAccuracyUnit()

Checks whether the optional TemperatureAccuracyUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTTL(value, validate=True)

Sets the value of the TTL attribute.

This field captures whether (True) or not (False) this Environmental Control Device can be controlled by a TTL signal.

Parameters:

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

getTTL()

Returns the value of the TTL attribute.

This field captures whether (True) or not (False) this Environmental Control Device can be controlled by a TTL signal.

Returns:

Type	Description
boolean	The value of the attribute

resetTTL()

Resets the TTL attribute to an unset state.

This field captures whether (True) or not (False) this Environmental Control Device can be controlled by a TTL signal.

hasTTL()

Checks whether the TTL attribute is present.

This field captures whether (True) or not (False) this Environmental Control Device can be controlled by a TTL signal.

Returns:

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

setAnnotationRef(value, validate=True)

Sets the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Parameters:

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

getAnnotationRef()

Returns the value of the AnnotationRef element.

This is a simple multi-line comment or annotation describing this component.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

This is a simple multi-line comment or annotation describing this component.

Returns:

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