com.inscoper.nbo.PlateAcquisition¶

Represents the XML element PlateAcquisition. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	PlateAcquisition()
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(PlateAcquisitionID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(PlateAcquisitionID_Type value) Sets the value of the ID attribute.
PlateAcquisitionID_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	setEndTime(String value, boolean validate) Sets the value of the EndTime attribute.
void	setEndTime(String value) Sets the value of the EndTime attribute.
String	getEndTime() Returns the value of the EndTime attribute.
void	resetEndTime() Resets the EndTime attribute to an unset state.
boolean	hasEndTime() Checks whether the EndTime attribute is present.
void	setStartTime(String value, boolean validate) Sets the value of the StartTime attribute.
void	setStartTime(String value) Sets the value of the StartTime attribute.
String	getStartTime() Returns the value of the StartTime attribute.
void	resetStartTime() Resets the StartTime attribute to an unset state.
boolean	hasStartTime() Checks whether the StartTime attribute is present.
void	setMaximumFieldCount(PositiveInt_Type value, boolean validate) Sets the value of the MaximumFieldCount attribute.
void	setMaximumFieldCount(PositiveInt_Type value) Sets the value of the MaximumFieldCount attribute.
PositiveInt_Type	getMaximumFieldCount() Returns the value of the MaximumFieldCount attribute.
void	resetMaximumFieldCount() Resets the MaximumFieldCount attribute to an unset state.
boolean	hasMaximumFieldCount() Checks whether the optional MaximumFieldCount attribute is present.
void	setDescription(PlateAcquisition_InlineDescription value, boolean validate) Sets the value of the Description element.
void	setDescription(PlateAcquisition_InlineDescription value) Sets the value of the Description element.
PlateAcquisition_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	setWellSampleRef_List(WellSampleRefVector value, boolean validate) Sets the list of WellSampleRef elements.
void	setWellSampleRef_List(WellSampleRefVector value) Sets the list of WellSampleRef elements.
WellSampleRefVector	getWellSampleRef_List() Returns the list of WellSampleRef elements.
void	addToWellSampleRef_List(WellSampleRef value, boolean validate) Adds a new WellSampleRef element to this object.
void	addToWellSampleRef_List(WellSampleRef value) Adds a new WellSampleRef element to this object.
void	clearWellSampleRef_List() Clear the list of WellSampleRef.
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.
PlateAcquisition	__internal_create(long cPtr, boolean own)
PlateAcquisition	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a PlateAcquisition.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getEndTimeAllowedValues() Returns the allowed values for this attribut.
StringSet	getStartTimeAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	PlateAcquisition(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(PlateAcquisition 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.PlateAcquisition;

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.

Public Functions Documentation¶

function delete¶

function PlateAcquisition¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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¶

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¶

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¶

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¶

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¶

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¶

function setID¶

public void setID(
    PlateAcquisitionID_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¶

function getID¶

function resetID¶

function hasID¶

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.

No description available in the XSD standard.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setEndTime¶

public void setEndTime(
    String value,
    boolean validate
)

Sets the value of the EndTime attribute.

Parameters:

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

Time when the last Image of this Acquisition was collected

function setEndTime¶

function getEndTime¶

function resetEndTime¶

function hasEndTime¶

public boolean hasEndTime()

Checks whether the EndTime attribute is present.

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

Time when the last Image of this Acquisition was collected

function setStartTime¶

public void setStartTime(
    String value,
    boolean validate
)

Sets the value of the StartTime attribute.

Parameters:

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

Time when the first Image of this Acquisition was collected

function setStartTime¶

function getStartTime¶

function resetStartTime¶

function hasStartTime¶

public boolean hasStartTime()

Checks whether the StartTime attribute is present.

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

Time when the first Image of this Acquisition was collected

function setMaximumFieldCount¶

public void setMaximumFieldCount(
    PositiveInt_Type value,
    boolean validate
)

Sets the value of the MaximumFieldCount attribute.

Parameters:

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

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.

function setMaximumFieldCount¶

public void setMaximumFieldCount(
    PositiveInt_Type value
)

Sets the value of the MaximumFieldCount attribute.

Parameters:

value The value to set

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.

function getMaximumFieldCount¶

public PositiveInt_Type getMaximumFieldCount()

Returns the value of the MaximumFieldCount attribute.

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

function resetMaximumFieldCount¶

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

function hasMaximumFieldCount¶

public boolean hasMaximumFieldCount()

Checks whether the optional MaximumFieldCount attribute is present.

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

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.

function setDescription¶

public void setDescription(
    PlateAcquisition_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 PlateAcquisition.

function setDescription¶

public void setDescription(
    PlateAcquisition_InlineDescription value
)

Sets the value of the Description element.

Parameters:

value The value to set

A description for the PlateAcquisition.

function getDescription¶

function resetDescription¶

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

function setWellSampleRef_List¶

public void setWellSampleRef_List(
    WellSampleRefVector value,
    boolean validate
)

Sets the list of WellSampleRef elements.

Parameters:

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

No description available in the XSD standard.

function setWellSampleRef_List¶

public void setWellSampleRef_List(
    WellSampleRefVector value
)

Sets the list of WellSampleRef elements.

Parameters:

value The new list of WellSampleRef elements

No description available in the XSD standard.

function getWellSampleRef_List¶

function addToWellSampleRef_List¶

public void addToWellSampleRef_List(
    WellSampleRef value,
    boolean validate
)

Adds a new WellSampleRef 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 addToWellSampleRef_List¶

public void addToWellSampleRef_List(
    WellSampleRef value
)

Adds a new WellSampleRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearWellSampleRef_List¶

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¶

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¶

function __internal_create¶

function fromBase¶

public static PlateAcquisition fromBase(
    NBOBaseClass base
)

com.inscoper.nbo.PlateAcquisition¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function PlateAcquisition¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setID¶

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

function setName¶

function getName¶

function resetName¶

function hasName¶

function setEndTime¶

function setEndTime¶

function getEndTime¶

function resetEndTime¶

function hasEndTime¶

function setStartTime¶

function setStartTime¶

function getStartTime¶

function resetStartTime¶

function hasStartTime¶

function setMaximumFieldCount¶

function setMaximumFieldCount¶

function getMaximumFieldCount¶

function resetMaximumFieldCount¶

function hasMaximumFieldCount¶

function setDescription¶

function setDescription¶

function getDescription¶

function resetDescription¶

function hasDescription¶

function setWellSampleRef_List¶

function setWellSampleRef_List¶

function getWellSampleRef_List¶

function addToWellSampleRef_List¶

function addToWellSampleRef_List¶

function clearWellSampleRef_List¶

function setAnnotationRef_List¶

function setAnnotationRef_List¶

function getAnnotationRef_List¶

function addToAnnotationRef_List¶

function addToAnnotationRef_List¶

function clearAnnotationRef_List¶

function __internal_create¶

function fromBase¶

function getNameAllowedValues¶

function getEndTimeAllowedValues¶

function getStartTimeAllowedValues¶

Protected Functions Documentation¶

function PlateAcquisition¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶