CoverGlass¶
Bases: ManufacturerSpec_Type
Represents the XML element CoverGlass.
This element describes a rectangular or circular piece of thin glass used to cover a microscopical preparation.
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 |
|---|---|
CoverGlass
|
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 |
setCoating(value, validate=True)
¶
Sets the value of the Coating attribute.
This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).
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
|
getCoating()
¶
Returns the value of the Coating attribute.
This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetCoating()
¶
Resets the Coating attribute to an unset state.
This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).
hasCoating()
¶
Checks whether the Coating attribute is present.
This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |
getCoatingAllowedValues()
staticmethod
¶
Returns the allowed values for this attribut.
This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).
Returns:
| Type | Description |
|---|---|
std::set< str,std::less< str >,std::allocator< str > >
|
The list of allowed values |
setCoverGlassNo(value, validate=True)
¶
Sets the value of the CoverGlassNo attribute.
This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
CoverGlassNr_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getCoverGlassNo()
¶
Returns the value of the CoverGlassNo attribute.
This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.
Returns:
| Type | Description |
|---|---|
CoverGlassNr_Type
|
The value of the attribute |
resetCoverGlassNo()
¶
Resets the CoverGlassNo attribute to an unset state.
This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.
hasCoverGlassNo()
¶
Checks whether the optional CoverGlassNo attribute is present.
This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setThickness(value, validate=True)
¶
Sets the value of the Thickness attribute.
This fields reports the measured thickness of this Coverslip expressed in mm.
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
|
getThickness()
¶
Returns the value of the Thickness attribute.
This fields reports the measured thickness of this Coverslip expressed in mm.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetThickness()
¶
Resets the Thickness attribute to an unset state.
This fields reports the measured thickness of this Coverslip expressed in mm.
hasThickness()
¶
Checks whether the Thickness attribute is present.
This fields reports the measured thickness of this Coverslip expressed in mm.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |