MountingMedium

Bases: ManufacturerSpec_Type

Represents the XML element MountingMedium.

This element refers to the Mounting Medium that was used during the acquisition of this Image. According to ISO 10934-1:2002, a Mounting Medium is a liquid, synthetic resin or other medium in which this Specimen is placed during Image Acquisition. NOTE For fixed Samples observed by transmitted-light microscopy, this Medium is transparent, colourless and of specified refractive index, enclosed between the slide and the cover glass. For reflected-light microscopy, the mounting medium is normally a resin with which the Sample is impregnated so that a polished section may be made. For live Samples, the Medium is typically the tissue culture growth substrate.

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
MountingMedium	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

setType(value, validate=True)

Sets the value of the Type attribute.

This field records the general category to which this Mounting Medium belongs.

Parameters:

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

getType()

Returns the value of the Type attribute.

This field records the general category to which this Mounting Medium belongs.

Returns:

Type	Description
MountingMediumType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field records the general category to which this Mounting Medium belongs.

hasType()

Checks whether the optional Type attribute is present.

This field records the general category to which this Mounting Medium belongs.

Returns:

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

setRefractiveIndex(value, validate=True)

Sets the value of the RefractiveIndex attribute.

This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.

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

getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.

hasRefractiveIndex()

Checks whether the RefractiveIndex attribute is present.

This field reocrds the nominal Refractive Index of this Mounting Medium, as specified by the Manufacturer.

Returns:

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