SampleHolder¶
Bases: ManufacturerSpec_Type
Represents the XML element SampleHolder.
This element describes the device (often referred to as Sample Carrier, Container or Vessel) on which the specimen was mounted for microscopical examination. It typically is flat and it could be made of glass or plastic. Examples include Microscope slides, Petri dishes, and multi-well plates.
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 |
|---|---|
SampleHolder
|
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 Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
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
|
getType()
¶
Returns the value of the Type attribute.
This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetType()
¶
Resets the Type attribute to an unset state.
This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
hasType()
¶
Checks whether the Type attribute is present.
This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |
getTypeAllowedValues()
staticmethod
¶
Returns the allowed values for this attribut.
This field records the Type of this Sample Holder. Options include, microscope slide, Petri dish, tissue culture plate, micro-well plate, etc. (e.g. 35 mm MatTek Glass Bottom Dish).
Returns:
| Type | Description |
|---|---|
std::set< str,std::less< str >,std::allocator< str > >
|
The list of allowed values |