com.inscoper.nbo.Plate¶

Represents the XML element Plate. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	Plate()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(PlateID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(PlateID_Type value) Sets the value of the ID attribute.
PlateID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(String value, boolean validate) Sets the value of the Name attribute.
void	setName(String value) Sets the value of the Name attribute.
String	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the Name attribute is present.
void	setStatus(String value, boolean validate) Sets the value of the Status attribute.
void	setStatus(String value) Sets the value of the Status attribute.
String	getStatus() Returns the value of the Status attribute.
void	resetStatus() Resets the Status attribute to an unset state.
boolean	hasStatus() Checks whether the Status attribute is present.
void	setExternalIdentifier(String value, boolean validate) Sets the value of the ExternalIdentifier attribute.
void	setExternalIdentifier(String value) Sets the value of the ExternalIdentifier attribute.
String	getExternalIdentifier() Returns the value of the ExternalIdentifier attribute.
void	resetExternalIdentifier() Resets the ExternalIdentifier attribute to an unset state.
boolean	hasExternalIdentifier() Checks whether the ExternalIdentifier attribute is present.
void	setColumnNamingConvention(NamingConvention_Type value, boolean validate) Sets the value of the ColumnNamingConvention attribute.
void	setColumnNamingConvention(NamingConvention_Type value) Sets the value of the ColumnNamingConvention attribute.
NamingConvention_Type	getColumnNamingConvention() Returns the value of the ColumnNamingConvention attribute.
void	resetColumnNamingConvention() Resets the ColumnNamingConvention attribute to an unset state.
boolean	hasColumnNamingConvention() Checks whether the optional ColumnNamingConvention attribute is present.
void	setRowNamingConvention(NamingConvention_Type value, boolean validate) Sets the value of the RowNamingConvention attribute.
void	setRowNamingConvention(NamingConvention_Type value) Sets the value of the RowNamingConvention attribute.
NamingConvention_Type	getRowNamingConvention() Returns the value of the RowNamingConvention attribute.
void	resetRowNamingConvention() Resets the RowNamingConvention attribute to an unset state.
boolean	hasRowNamingConvention() Checks whether the optional RowNamingConvention attribute is present.
void	setWellOriginX(float value, boolean validate) Sets the value of the WellOriginX attribute.
void	setWellOriginX(float value) Sets the value of the WellOriginX attribute.
float	getWellOriginX() Returns the value of the WellOriginX attribute.
void	resetWellOriginX() Resets the WellOriginX attribute to an unset state.
boolean	hasWellOriginX() Checks whether the WellOriginX attribute is present.
void	setWellOriginXUnit(UnitsLength_Type value, boolean validate) Sets the value of the WellOriginXUnit attribute.
void	setWellOriginXUnit(UnitsLength_Type value) Sets the value of the WellOriginXUnit attribute.
UnitsLength_Type	getWellOriginXUnit() Returns the value of the WellOriginXUnit attribute.
void	resetWellOriginXUnit() Resets the WellOriginXUnit attribute to an unset state.
boolean	hasWellOriginXUnit() Checks whether the optional WellOriginXUnit attribute is present.
void	setWellOriginY(float value, boolean validate) Sets the value of the WellOriginY attribute.
void	setWellOriginY(float value) Sets the value of the WellOriginY attribute.
float	getWellOriginY() Returns the value of the WellOriginY attribute.
void	resetWellOriginY() Resets the WellOriginY attribute to an unset state.
boolean	hasWellOriginY() Checks whether the WellOriginY attribute is present.
void	setWellOriginYUnit(UnitsLength_Type value, boolean validate) Sets the value of the WellOriginYUnit attribute.
void	setWellOriginYUnit(UnitsLength_Type value) Sets the value of the WellOriginYUnit attribute.
UnitsLength_Type	getWellOriginYUnit() Returns the value of the WellOriginYUnit attribute.
void	resetWellOriginYUnit() Resets the WellOriginYUnit attribute to an unset state.
boolean	hasWellOriginYUnit() Checks whether the optional WellOriginYUnit attribute is present.
void	setRows(PositiveInt_Type value, boolean validate) Sets the value of the Rows attribute.
void	setRows(PositiveInt_Type value) Sets the value of the Rows attribute.
PositiveInt_Type	getRows() Returns the value of the Rows attribute.
void	resetRows() Resets the Rows attribute to an unset state.
boolean	hasRows() Checks whether the optional Rows attribute is present.
void	setColumns(PositiveInt_Type value, boolean validate) Sets the value of the Columns attribute.
void	setColumns(PositiveInt_Type value) Sets the value of the Columns attribute.
PositiveInt_Type	getColumns() Returns the value of the Columns attribute.
void	resetColumns() Resets the Columns attribute to an unset state.
boolean	hasColumns() Checks whether the optional Columns attribute is present.
void	setFieldIndex(NonNegativeInt_Type value, boolean validate) Sets the value of the FieldIndex attribute.
void	setFieldIndex(NonNegativeInt_Type value) Sets the value of the FieldIndex attribute.
NonNegativeInt_Type	getFieldIndex() Returns the value of the FieldIndex attribute.
void	resetFieldIndex() Resets the FieldIndex attribute to an unset state.
boolean	hasFieldIndex() Checks whether the optional FieldIndex attribute is present.
void	setDescription(Plate_InlineDescription value, boolean validate) Sets the value of the Description element.
void	setDescription(Plate_InlineDescription value) Sets the value of the Description element.
Plate_InlineDescription	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setWell_List(WellVector value, boolean validate) Sets the list of Well elements.
void	setWell_List(WellVector value) Sets the list of Well elements.
WellVector	getWell_List() Returns the list of Well elements.
void	addToWell_List(Well value, boolean validate) Adds a new Well element to this object.
void	addToWell_List(Well value) Adds a new Well element to this object.
void	clearWell_List() Clear the list of Well.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
void	setPlateAcquisition_List(PlateAcquisitionVector value, boolean validate) Sets the list of PlateAcquisition elements.
void	setPlateAcquisition_List(PlateAcquisitionVector value) Sets the list of PlateAcquisition elements.
PlateAcquisitionVector	getPlateAcquisition_List() Returns the list of PlateAcquisition elements.
void	addToPlateAcquisition_List(PlateAcquisition value, boolean validate) Adds a new PlateAcquisition element to this object.
void	addToPlateAcquisition_List(PlateAcquisition value) Adds a new PlateAcquisition element to this object.
void	clearPlateAcquisition_List() Clear the list of PlateAcquisition.
Plate	__internal_create(long cPtr, boolean own)
Plate	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getStatusAllowedValues() Returns the allowed values for this attribut.
StringSet	getExternalIdentifierAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Plate(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Plate obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Plate;

Represents the XML element Plate.

A description for the plate.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Plate¶

public Plate()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    PlateID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setID¶

public void setID(
    PlateID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getID¶

public PlateID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setName¶

public void setName(
    String value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setName¶

public void setName(
    String value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

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.

function getName¶

public String getName()

Returns the value of the Name attribute.

Return: The value of the 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.

function resetName¶

public void 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.

function hasName¶

public boolean hasName()

Checks whether the Name attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setStatus¶

public void setStatus(
    String value,
    boolean validate
)

Sets the value of the Status attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setStatus¶

public void setStatus(
    String value
)

Sets the value of the Status attribute.

Parameters:

value The value to set

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.

function getStatus¶

public String getStatus()

Returns the value of the Status attribute.

Return: The value of the 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.

function resetStatus¶

public void 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.

function hasStatus¶

public boolean hasStatus()

Checks whether the Status attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setExternalIdentifier¶

public void setExternalIdentifier(
    String value,
    boolean validate
)

Sets the value of the ExternalIdentifier attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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

function setExternalIdentifier¶

public void setExternalIdentifier(
    String value
)

Sets the value of the ExternalIdentifier attribute.

Parameters:

value The value to set

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

function getExternalIdentifier¶

public String getExternalIdentifier()

Returns the value of the ExternalIdentifier attribute.

Return: The value of the attribute

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

function resetExternalIdentifier¶

public void resetExternalIdentifier()

Resets the ExternalIdentifier attribute to an unset state.

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

function hasExternalIdentifier¶

public boolean hasExternalIdentifier()

Checks whether the ExternalIdentifier attribute is present.

Return: true if the attribute has been set, false otherwise

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

function setColumnNamingConvention¶

public void setColumnNamingConvention(
    NamingConvention_Type value,
    boolean validate
)

Sets the value of the ColumnNamingConvention attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The ColumnNamingConvention

function setColumnNamingConvention¶

public void setColumnNamingConvention(
    NamingConvention_Type value
)

Sets the value of the ColumnNamingConvention attribute.

Parameters:

value The value to set

The ColumnNamingConvention

function getColumnNamingConvention¶

public NamingConvention_Type getColumnNamingConvention()

Returns the value of the ColumnNamingConvention attribute.

Return: The value of the attribute

The ColumnNamingConvention

function resetColumnNamingConvention¶

public void resetColumnNamingConvention()

Resets the ColumnNamingConvention attribute to an unset state.

The ColumnNamingConvention

function hasColumnNamingConvention¶

public boolean hasColumnNamingConvention()

Checks whether the optional ColumnNamingConvention attribute is present.

Return: true if the optional attribute has been set, false otherwise

The ColumnNamingConvention

function setRowNamingConvention¶

public void setRowNamingConvention(
    NamingConvention_Type value,
    boolean validate
)

Sets the value of the RowNamingConvention attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The RowNamingConvention

function setRowNamingConvention¶

public void setRowNamingConvention(
    NamingConvention_Type value
)

Sets the value of the RowNamingConvention attribute.

Parameters:

value The value to set

The RowNamingConvention

function getRowNamingConvention¶

public NamingConvention_Type getRowNamingConvention()

Returns the value of the RowNamingConvention attribute.

Return: The value of the attribute

The RowNamingConvention

function resetRowNamingConvention¶

public void resetRowNamingConvention()

Resets the RowNamingConvention attribute to an unset state.

The RowNamingConvention

function hasRowNamingConvention¶

public boolean hasRowNamingConvention()

Checks whether the optional RowNamingConvention attribute is present.

Return: true if the optional attribute has been set, false otherwise

The RowNamingConvention

function setWellOriginX¶

public void setWellOriginX(
    float value,
    boolean validate
)

Sets the value of the WellOriginX attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setWellOriginX¶

public void setWellOriginX(
    float value
)

Sets the value of the WellOriginX attribute.

Parameters:

value The value to set

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.

function getWellOriginX¶

public float getWellOriginX()

Returns the value of the WellOriginX attribute.

Return: The value of the 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.

function resetWellOriginX¶

public void 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.

function hasWellOriginX¶

public boolean hasWellOriginX()

Checks whether the WellOriginX attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setWellOriginXUnit¶

public void setWellOriginXUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the WellOriginXUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setWellOriginXUnit¶

public void setWellOriginXUnit(
    UnitsLength_Type value
)

Sets the value of the WellOriginXUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getWellOriginXUnit¶

public UnitsLength_Type getWellOriginXUnit()

Returns the value of the WellOriginXUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetWellOriginXUnit¶

public void resetWellOriginXUnit()

Resets the WellOriginXUnit attribute to an unset state.

No description available in the XSD standard.

function hasWellOriginXUnit¶

public boolean hasWellOriginXUnit()

Checks whether the optional WellOriginXUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setWellOriginY¶

public void setWellOriginY(
    float value,
    boolean validate
)

Sets the value of the WellOriginY attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function setWellOriginY¶

public void setWellOriginY(
    float value
)

Sets the value of the WellOriginY attribute.

Parameters:

value The value to set

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.

function getWellOriginY¶

public float getWellOriginY()

Returns the value of the WellOriginY attribute.

Return: The value of the 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.

function resetWellOriginY¶

public void 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.

function hasWellOriginY¶

public boolean hasWellOriginY()

Checks whether the WellOriginY attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function setWellOriginYUnit¶

public void setWellOriginYUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the WellOriginYUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setWellOriginYUnit¶

public void setWellOriginYUnit(
    UnitsLength_Type value
)

Sets the value of the WellOriginYUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getWellOriginYUnit¶

public UnitsLength_Type getWellOriginYUnit()

Returns the value of the WellOriginYUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetWellOriginYUnit¶

public void resetWellOriginYUnit()

Resets the WellOriginYUnit attribute to an unset state.

No description available in the XSD standard.

function hasWellOriginYUnit¶

public boolean hasWellOriginYUnit()

Checks whether the optional WellOriginYUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setRows¶

public void setRows(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the Rows attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The number of rows in the plate

function setRows¶

public void setRows(
    PositiveInt_Type value
)

Sets the value of the Rows attribute.

Parameters:

value The value to set

The number of rows in the plate

function getRows¶

public PositiveInt_Type getRows()

Returns the value of the Rows attribute.

Return: The value of the attribute

The number of rows in the plate

function resetRows¶

public void resetRows()

Resets the Rows attribute to an unset state.

The number of rows in the plate

function hasRows¶

public boolean hasRows()

Checks whether the optional Rows attribute is present.

Return: true if the optional attribute has been set, false otherwise

The number of rows in the plate

function setColumns¶

public void setColumns(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the Columns attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The number of columns in the plate

function setColumns¶

public void setColumns(
    PositiveInt_Type value
)

Sets the value of the Columns attribute.

Parameters:

value The value to set

The number of columns in the plate

function getColumns¶

public PositiveInt_Type getColumns()

Returns the value of the Columns attribute.

Return: The value of the attribute

The number of columns in the plate

function resetColumns¶

public void resetColumns()

Resets the Columns attribute to an unset state.

The number of columns in the plate

function hasColumns¶

public boolean hasColumns()

Checks whether the optional Columns attribute is present.

Return: true if the optional attribute has been set, false otherwise

The number of columns in the plate

function setFieldIndex¶

public void setFieldIndex(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the FieldIndex attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The index of the WellSample to display as the default Field

function setFieldIndex¶

public void setFieldIndex(
    NonNegativeInt_Type value
)

Sets the value of the FieldIndex attribute.

Parameters:

value The value to set

The index of the WellSample to display as the default Field

function getFieldIndex¶

public NonNegativeInt_Type getFieldIndex()

Returns the value of the FieldIndex attribute.

Return: The value of the attribute

The index of the WellSample to display as the default Field

function resetFieldIndex¶

public void resetFieldIndex()

Resets the FieldIndex attribute to an unset state.

The index of the WellSample to display as the default Field

function hasFieldIndex¶

public boolean hasFieldIndex()

Checks whether the optional FieldIndex attribute is present.

Return: true if the optional attribute has been set, false otherwise

The index of the WellSample to display as the default Field

function setDescription¶

public void setDescription(
    Plate_InlineDescription value,
    boolean validate
)

Sets the value of the Description element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A description for the plate.

function setDescription¶

public void setDescription(
    Plate_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

A description for the plate.

function getDescription¶

public Plate_InlineDescription getDescription()

Returns the value of the Description element.

Return: The value of the element

A description for the plate.

function resetDescription¶

public void resetDescription()

Resets the Description element to an unset state.

A description for the plate.

function hasDescription¶

public boolean hasDescription()

Checks whether the optional Description element is present.

Return: true if the optional attribute has been set, false otherwise

A description for the plate.

function setWell_List¶

public void setWell_List(
    WellVector value,
    boolean validate
)

Sets the list of Well elements.

Parameters:

value The new list of Well elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setWell_List¶

public void setWell_List(
    WellVector value
)

Sets the list of Well elements.

Parameters:

value The new list of Well elements

No description available in the XSD standard.

function getWell_List¶

public WellVector getWell_List()

Returns the list of Well elements.

Return: The list of Well elements

No description available in the XSD standard.

function addToWell_List¶

public void addToWell_List(
    Well value,
    boolean validate
)

Adds a new Well element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToWell_List¶

public void addToWell_List(
    Well value
)

Adds a new Well element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearWell_List¶

public void clearWell_List()

Clear the list of Well.

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value,
    boolean validate
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

No description available in the XSD standard.

function getAnnotationRef_List¶

public AnnotationRefVector getAnnotationRef_List()

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value,
    boolean validate
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAnnotationRef_List¶

public void clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.

function setPlateAcquisition_List¶

public void setPlateAcquisition_List(
    PlateAcquisitionVector value,
    boolean validate
)

Sets the list of PlateAcquisition elements.

Parameters:

value The new list of PlateAcquisition elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPlateAcquisition_List¶

public void setPlateAcquisition_List(
    PlateAcquisitionVector value
)

Sets the list of PlateAcquisition elements.

Parameters:

value The new list of PlateAcquisition elements

No description available in the XSD standard.

function getPlateAcquisition_List¶

public PlateAcquisitionVector getPlateAcquisition_List()

Returns the list of PlateAcquisition elements.

Return: The list of PlateAcquisition elements

No description available in the XSD standard.

function addToPlateAcquisition_List¶

public void addToPlateAcquisition_List(
    PlateAcquisition value,
    boolean validate
)

Adds a new PlateAcquisition element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToPlateAcquisition_List¶

public void addToPlateAcquisition_List(
    PlateAcquisition value
)

Adds a new PlateAcquisition element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearPlateAcquisition_List¶

public void clearPlateAcquisition_List()

Clear the list of PlateAcquisition.

No description available in the XSD standard.

function __internal_create¶

public static Plate __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static Plate fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getNameAllowedValues¶

public static StringSet getNameAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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.

function getStatusAllowedValues¶

public static StringSet getStatusAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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.

function getExternalIdentifierAllowedValues¶

public static StringSet getExternalIdentifierAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

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

Protected Functions Documentation¶

function Plate¶

protected Plate(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr¶

protected static long getCPtr(
    Plate obj
)

Updated on 2026-06-22 at 17:06:32 +0200