Well

Bases: NBOBaseClass

Represents the XML element Well.

A Well is a component of the Well/Plate/Screen construct to describe screening applications. A Well has a number of WellSample elements that link to the Images collected in this well. The ReagentRef links any Reagents that were used in this Well. A well is part of only one Plate. The origin for the row and column identifiers is the top left corner of the plate starting at zero. i.e The top left well of a plate is index (0,0)

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

No description available in the XSD standard.

Parameters:

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

No description available in the XSD standard.

Returns:

Type	Description
WellID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

hasID()

Checks whether the optional ID attribute is present.

No description available in the XSD standard.

Returns:

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

setColumn(value, validate=True)

Sets the value of the Column attribute.

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

Parameters:

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

getColumn()

Returns the value of the Column attribute.

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetColumn()

Resets the Column attribute to an unset state.

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

hasColumn()

Checks whether the optional Column attribute is present.

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

Returns:

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

setRow(value, validate=True)

Sets the value of the Row attribute.

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

Parameters:

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

getRow()

Returns the value of the Row attribute.

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetRow()

Resets the Row attribute to an unset state.

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

hasRow()

Checks whether the optional Row attribute is present.

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

Returns:

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

setExternalDescription(value, validate=True)

Sets the value of the ExternalDescription attribute.

A description of the externally defined identifier for this plate.

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

getExternalDescription()

Returns the value of the ExternalDescription attribute.

A description of the externally defined identifier for this plate.

Returns:

Type	Description
string	The value of the attribute

resetExternalDescription()

Resets the ExternalDescription attribute to an unset state.

A description of the externally defined identifier for this plate.

hasExternalDescription()

Checks whether the ExternalDescription attribute is present.

A description of the externally defined identifier for this plate.

Returns:

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

getExternalDescriptionAllowedValues() staticmethod

Returns the allowed values for this attribut.

A description of the externally defined identifier for this plate.

Returns:

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

setExternalIdentifier(value, validate=True)

Sets the value of the ExternalIdentifier attribute.

The ExternalIdentifier attribute may contain a reference to an external database.

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

getExternalIdentifier()

Returns the value of the ExternalIdentifier attribute.

The ExternalIdentifier attribute may contain a reference to an external database.

Returns:

Type	Description
string	The value of the attribute

resetExternalIdentifier()

Resets the ExternalIdentifier attribute to an unset state.

The ExternalIdentifier attribute may contain a reference to an external database.

hasExternalIdentifier()

Checks whether the ExternalIdentifier attribute is present.

The ExternalIdentifier attribute may contain a reference to an external database.

Returns:

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

getExternalIdentifierAllowedValues() staticmethod

Returns the allowed values for this attribut.

The ExternalIdentifier attribute may contain a reference to an external database.

Returns:

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

setType(value, validate=True)

Sets the value of the Type attribute.

No description available in the XSD standard.

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.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

No description available in the XSD standard.

hasType()

Checks whether the Type attribute is present.

No description available in the XSD standard.

Returns:

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

getTypeAllowedValues() staticmethod

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

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

setColor(value, validate=True)

Sets the value of the Color attribute.

No description available in the XSD standard.

Parameters:

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

getColor()

Returns the value of the Color attribute.

No description available in the XSD standard.

Returns:

Type	Description
Color_Type	The value of the attribute

resetColor()

Resets the Color attribute to an unset state.

No description available in the XSD standard.

hasColor()

Checks whether the optional Color attribute is present.

No description available in the XSD standard.

Returns:

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

setWellSample_List(value, validate=True)

Sets the list of WellSample elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[WellSample]	The new list of WellSample elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getWellSample_List()

Returns the list of WellSample elements.

No description available in the XSD standard.

Returns:

Type	Description
List[WellSample]	The list of WellSample elements

addToWellSample_List(value, validate=True)

Adds a new WellSample element to this object.

No description available in the XSD standard.

Parameters:

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

clearWellSample_List()

Clear the list of WellSample.

No description available in the XSD standard.

setReagentRef(value, validate=True)

Sets the value of the ReagentRef element.

No description available in the XSD standard.

Parameters:

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

getReagentRef()

Returns the value of the ReagentRef element.

No description available in the XSD standard.

Returns:

Type	Description
ReagentRef	The value of the element

resetReagentRef()

Resets the ReagentRef element to an unset state.

No description available in the XSD standard.

hasReagentRef()

Checks whether the optional ReagentRef element is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef_List(value, validate=True)

Sets the list of AnnotationRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AnnotationRef]	The new list of AnnotationRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value, validate=True)

Adds a new AnnotationRef element to this object.

No description available in the XSD standard.

Parameters:

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

clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.