Plate

Bases: NBOBaseClass

Represents the XML element Plate.

A description for the plate.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value)

Sets the value of the ID attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	PlateID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

No description available in the XSD standard.

Returns:

Type	Description
PlateID_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)

Sets the value of the Name attribute.

The Name identifies the plate to the user. It is used much like the ID, and so must be unique within the document. If a plate name is not available when one is needed it will be constructed in the following order: 1. If name is available use it. 2. If not use "Start time - End time" (NOTE: Not a subtraction! A string representation of the two times separated by a dash.) 3. If these times are not available use the Plate ID.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getName()

Returns the value of the Name attribute.

The Name identifies the plate to the user. It is used much like the ID, and so must be unique within the document. If a plate name is not available when one is needed it will be constructed in the following order: 1. If name is available use it. 2. If not use "Start time - End time" (NOTE: Not a subtraction! A string representation of the two times separated by a dash.) 3. If these times are not available use the Plate ID.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

The Name identifies the plate to the user. It is used much like the ID, and so must be unique within the document. If a plate name is not available when one is needed it will be constructed in the following order: 1. If name is available use it. 2. If not use "Start time - End time" (NOTE: Not a subtraction! A string representation of the two times separated by a dash.) 3. If these times are not available use the Plate ID.

hasName()

Checks whether the optional Name attribute is present.

The Name identifies the plate to the user. It is used much like the ID, and so must be unique within the document. If a plate name is not available when one is needed it will be constructed in the following order: 1. If name is available use it. 2. If not use "Start time - End time" (NOTE: Not a subtraction! A string representation of the two times separated by a dash.) 3. If these times are not available use the Plate ID.

Returns:

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

setStatus(value)

Sets the value of the Status attribute.

A textual annotation of the current state of the plate with respect to the experiment work-flow; e.g. 1. Seed cell: done; 2. Transfection: done; 3. Gel doc: todo.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required

getStatus()

Returns the value of the Status attribute.

A textual annotation of the current state of the plate with respect to the experiment work-flow; e.g. 1. Seed cell: done; 2. Transfection: done; 3. Gel doc: todo.

Returns:

Type	Description
string	The value of the attribute

resetStatus()

Resets the Status attribute to an unset state.

A textual annotation of the current state of the plate with respect to the experiment work-flow; e.g. 1. Seed cell: done; 2. Transfection: done; 3. Gel doc: todo.

hasStatus()

Checks whether the optional Status attribute is present.

A textual annotation of the current state of the plate with respect to the experiment work-flow; e.g. 1. Seed cell: done; 2. Transfection: done; 3. Gel doc: todo.

Returns:

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

setExternalIdentifier(value)

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

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 optional ExternalIdentifier attribute is present.

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

Returns:

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

setColumnNamingConvention(value)

Sets the value of the ColumnNamingConvention attribute.

The ColumnNamingConvention

Parameters:

Name	Type	Description	Default
value	NamingConvention_Type	The value to set	required

getColumnNamingConvention()

Returns the value of the ColumnNamingConvention attribute.

The ColumnNamingConvention

Returns:

Type	Description
NamingConvention_Type	The value of the attribute

resetColumnNamingConvention()

Resets the ColumnNamingConvention attribute to an unset state.

The ColumnNamingConvention

hasColumnNamingConvention()

Checks whether the optional ColumnNamingConvention attribute is present.

The ColumnNamingConvention

Returns:

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

setRowNamingConvention(value)

Sets the value of the RowNamingConvention attribute.

The RowNamingConvention

Parameters:

Name	Type	Description	Default
value	NamingConvention_Type	The value to set	required

getRowNamingConvention()

Returns the value of the RowNamingConvention attribute.

The RowNamingConvention

Returns:

Type	Description
NamingConvention_Type	The value of the attribute

resetRowNamingConvention()

Resets the RowNamingConvention attribute to an unset state.

The RowNamingConvention

hasRowNamingConvention()

Checks whether the optional RowNamingConvention attribute is present.

The RowNamingConvention

Returns:

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

setWellOriginX(value)

Sets the value of the WellOriginX attribute.

This defines the X position to use for the origin of the fields (individual images) taken in a well. It is used with the X in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginXUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getWellOriginX()

Returns the value of the WellOriginX attribute.

This defines the X position to use for the origin of the fields (individual images) taken in a well. It is used with the X in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginXUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

Returns:

Type	Description
float	The value of the attribute

resetWellOriginX()

Resets the WellOriginX attribute to an unset state.

This defines the X position to use for the origin of the fields (individual images) taken in a well. It is used with the X in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginXUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

hasWellOriginX()

Checks whether the optional WellOriginX attribute is present.

This defines the X position to use for the origin of the fields (individual images) taken in a well. It is used with the X in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginXUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

Returns:

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

setWellOriginXUnit(value)

Sets the value of the WellOriginXUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getWellOriginXUnit()

Returns the value of the WellOriginXUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetWellOriginXUnit()

Resets the WellOriginXUnit attribute to an unset state.

No description available in the XSD standard.

hasWellOriginXUnit()

Checks whether the optional WellOriginXUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setWellOriginY(value)

Sets the value of the WellOriginY attribute.

This defines the Y position to use for the origin of the fields (individual images) taken in a well. It is used with the Y in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginYUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getWellOriginY()

Returns the value of the WellOriginY attribute.

This defines the Y position to use for the origin of the fields (individual images) taken in a well. It is used with the Y in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginYUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

Returns:

Type	Description
float	The value of the attribute

resetWellOriginY()

Resets the WellOriginY attribute to an unset state.

This defines the Y position to use for the origin of the fields (individual images) taken in a well. It is used with the Y in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginYUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

hasWellOriginY()

Checks whether the optional WellOriginY attribute is present.

This defines the Y position to use for the origin of the fields (individual images) taken in a well. It is used with the Y in the WellSample to display the fields in the correct position relative to each other. Each Well in the plate has the same well origin. Units are set by WellOriginYUnit. In the OMERO clients by convention we display the WellOrigin in the center of the view.

Returns:

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

setWellOriginYUnit(value)

Sets the value of the WellOriginYUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required

getWellOriginYUnit()

Returns the value of the WellOriginYUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetWellOriginYUnit()

Resets the WellOriginYUnit attribute to an unset state.

No description available in the XSD standard.

hasWellOriginYUnit()

Checks whether the optional WellOriginYUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setRows(value)

Sets the value of the Rows attribute.

The number of rows in the plate

Parameters:

Name	Type	Description	Default
value	PositiveInt_Type	The value to set	required

getRows()

Returns the value of the Rows attribute.

The number of rows in the plate

Returns:

Type	Description
PositiveInt_Type	The value of the attribute

resetRows()

Resets the Rows attribute to an unset state.

The number of rows in the plate

hasRows()

Checks whether the optional Rows attribute is present.

The number of rows in the plate

Returns:

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

setColumns(value)

Sets the value of the Columns attribute.

The number of columns in the plate

Parameters:

Name	Type	Description	Default
value	PositiveInt_Type	The value to set	required

getColumns()

Returns the value of the Columns attribute.

The number of columns in the plate

Returns:

Type	Description
PositiveInt_Type	The value of the attribute

resetColumns()

Resets the Columns attribute to an unset state.

The number of columns in the plate

hasColumns()

Checks whether the optional Columns attribute is present.

The number of columns in the plate

Returns:

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

setFieldIndex(value)

Sets the value of the FieldIndex attribute.

The index of the WellSample to display as the default Field

Parameters:

Name	Type	Description	Default
value	NonNegativeInt_Type	The value to set	required

getFieldIndex()

Returns the value of the FieldIndex attribute.

The index of the WellSample to display as the default Field

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetFieldIndex()

Resets the FieldIndex attribute to an unset state.

The index of the WellSample to display as the default Field

hasFieldIndex()

Checks whether the optional FieldIndex attribute is present.

The index of the WellSample to display as the default Field

Returns:

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

setDescription(value)

Sets the value of the Description element.

A description for the plate.

Parameters:

Name	Type	Description	Default
value	Plate_InlineDescription	The value to set	required

getDescription()

Returns the value of the Description element.

A description for the plate.

Returns:

Type	Description
Plate_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

A description for the plate.

hasDescription()

Checks whether the optional Description element is present.

A description for the plate.

Returns:

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

setWell_List(value)

Sets the list of Well elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[Well]	The new list of Well elements	required

getWell_List()

Returns the list of Well elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Well]	The list of Well elements

addToWell_List(value)

Adds a new Well element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Well	The element to add	required

clearWell_List()

Clear the list of Well.

No description available in the XSD standard.

setAnnotationRef_List(value)

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

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)

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

clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

setPlateAcquisition_List(value)

Sets the list of PlateAcquisition elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[PlateAcquisition]	The new list of PlateAcquisition elements	required

getPlateAcquisition_List()

Returns the list of PlateAcquisition elements.

No description available in the XSD standard.

Returns:

Type	Description
List[PlateAcquisition]	The list of PlateAcquisition elements

addToPlateAcquisition_List(value)

Adds a new PlateAcquisition element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	PlateAcquisition	The element to add	required

clearPlateAcquisition_List()

Clear the list of PlateAcquisition.

No description available in the XSD standard.