PlateAcquisition

Bases: NBOBaseClass

Represents the XML element PlateAcquisition.

PlateAcquisition is used to describe a single Acquisition run for a plate. This object is used to record the set of images acquired in a single Acquisition run. The Images for this run are linked to PlateAcquisition through WellSample.

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
PlateAcquisition	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	PlateAcquisitionID_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
PlateAcquisitionID_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

setName(value, validate=True)

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

getName()

Returns the value of the Name attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

No description available in the XSD standard.

hasName()

Checks whether the Name attribute is present.

No description available in the XSD standard.

Returns:

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

getNameAllowedValues() 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

setEndTime(value, validate=True)

Sets the value of the EndTime attribute.

Time when the last Image of this Acquisition was collected

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

getEndTime()

Returns the value of the EndTime attribute.

Time when the last Image of this Acquisition was collected

Returns:

Type	Description
string	The value of the attribute

resetEndTime()

Resets the EndTime attribute to an unset state.

Time when the last Image of this Acquisition was collected

hasEndTime()

Checks whether the EndTime attribute is present.

Time when the last Image of this Acquisition was collected

Returns:

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

getEndTimeAllowedValues() staticmethod

Returns the allowed values for this attribut.

Time when the last Image of this Acquisition was collected

Returns:

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

setStartTime(value, validate=True)

Sets the value of the StartTime attribute.

Time when the first Image of this Acquisition was collected

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

getStartTime()

Returns the value of the StartTime attribute.

Time when the first Image of this Acquisition was collected

Returns:

Type	Description
string	The value of the attribute

resetStartTime()

Resets the StartTime attribute to an unset state.

Time when the first Image of this Acquisition was collected

hasStartTime()

Checks whether the StartTime attribute is present.

Time when the first Image of this Acquisition was collected

Returns:

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

getStartTimeAllowedValues() staticmethod

Returns the allowed values for this attribut.

Time when the first Image of this Acquisition was collected

Returns:

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

setMaximumFieldCount(value, validate=True)

Sets the value of the MaximumFieldCount attribute.

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

Parameters:

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

getMaximumFieldCount()

Returns the value of the MaximumFieldCount attribute.

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

Returns:

Type	Description
PositiveInt_Type	The value of the attribute

resetMaximumFieldCount()

Resets the MaximumFieldCount attribute to an unset state.

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

hasMaximumFieldCount()

Checks whether the optional MaximumFieldCount attribute is present.

The maximum number of fields (well samples) in any well in this PlateAcquisition. This is only used to speed up user interaction by stopping the reading of every well sample.

Returns:

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

setDescription(value, validate=True)

Sets the value of the Description element.

A description for the PlateAcquisition.

Parameters:

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

getDescription()

Returns the value of the Description element.

A description for the PlateAcquisition.

Returns:

Type	Description
PlateAcquisition_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

A description for the PlateAcquisition.

hasDescription()

Checks whether the optional Description element is present.

A description for the PlateAcquisition.

Returns:

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

setWellSampleRef_List(value, validate=True)

Sets the list of WellSampleRef elements.

No description available in the XSD standard.

Parameters:

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

getWellSampleRef_List()

Returns the list of WellSampleRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[WellSampleRef]	The list of WellSampleRef elements

addToWellSampleRef_List(value, validate=True)

Adds a new WellSampleRef element to this object.

No description available in the XSD standard.

Parameters:

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

clearWellSampleRef_List()

Clear the list of WellSampleRef.

No description available in the XSD standard.

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.