Inscoper::NBO::PlateAcquisition¶

Represents the XML element PlateAcquisition. More...

#include <PlateAcquisition.h>

Inherits from NBOBaseClass

Public Classes¶

	Name
class	InlineDescription Represents the XML element Description.

Public Types¶

	Name
typedef std::shared_ptr< InlineDescription >	InlineDescriptionPtr

Public Functions¶

	Name
	PlateAcquisition()
	~PlateAcquisition()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::PlateAcquisitionID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
PlateAcquisitionID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setName(const std::string & value, bool validate =true) Sets the value of the Name attribute.
std::string	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the Name attribute is present.
void	setEndTime(const std::string & value, bool validate =true) Sets the value of the EndTime attribute.
std::string	getEndTime() const Returns the value of the EndTime attribute.
void	resetEndTime() Resets the EndTime attribute to an unset state.
bool	hasEndTime() const Checks whether the EndTime attribute is present.
void	setStartTime(const std::string & value, bool validate =true) Sets the value of the StartTime attribute.
std::string	getStartTime() const Returns the value of the StartTime attribute.
void	resetStartTime() Resets the StartTime attribute to an unset state.
bool	hasStartTime() const Checks whether the StartTime attribute is present.
void	setMaximumFieldCount(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the MaximumFieldCount attribute.
PositiveInt_TypePtr	getMaximumFieldCount() const Returns the value of the MaximumFieldCount attribute.
void	resetMaximumFieldCount() Resets the MaximumFieldCount attribute to an unset state.
bool	hasMaximumFieldCount() const Checks whether the optional MaximumFieldCount attribute is present.
void	setDescription(const Inscoper::NBO::PlateAcquisition::InlineDescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::PlateAcquisition::InlineDescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
void	setWellSampleRef_List(const std::vector< Inscoper::NBO::WellSampleRefPtr > & value, bool validate =true) Sets the list of WellSampleRef elements.
std::vector< Inscoper::NBO::WellSampleRefPtr >	getWellSampleRef_List() const Returns the list of WellSampleRef elements.
void	addToWellSampleRef_List(const Inscoper::NBO::WellSampleRefPtr & value, bool validate =true) Adds a new WellSampleRef element to this object.
void	clearWellSampleRef_List() Clear the list of WellSampleRef.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::AnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::AnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
std::shared_ptr< PlateAcquisition >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a PlateAcquisition.
const std::set< std::string > &	getNameAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getEndTimeAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getStartTimeAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class 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 Types Documentation¶

typedef InlineDescriptionPtr¶

Public Functions Documentation¶

function PlateAcquisition¶

function ~PlateAcquisition¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

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

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

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

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

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

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

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

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

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

std::string toXmlString(
    bool validate =true
) const

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

void setID(
    const Inscoper::NBO::PlateAcquisitionID_TypePtr & value,
    bool validate =true
)

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

function resetID¶

function hasID¶

function setName¶

void setName(
    const std::string & value,
    bool validate =true
)

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

function resetName¶

function hasName¶

function setEndTime¶

void setEndTime(
    const std::string & value,
    bool validate =true
)

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

function resetEndTime¶

function hasEndTime¶

function setStartTime¶

void setStartTime(
    const std::string & value,
    bool validate =true
)

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

function resetStartTime¶

function hasStartTime¶

bool hasStartTime() const

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¶

void setMaximumFieldCount(
    const Inscoper::NBO::PositiveInt_TypePtr & value,
    bool validate =true
)

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

PositiveInt_TypePtr getMaximumFieldCount() const

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¶

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¶

bool hasMaximumFieldCount() const

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¶

void setDescription(
    const Inscoper::NBO::PlateAcquisition::InlineDescriptionPtr & value,
    bool validate =true
)

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

Inscoper::NBO::PlateAcquisition::InlineDescriptionPtr getDescription() const

Returns the value of the Description element.

Return: The value of the element

A description for the PlateAcquisition.

function resetDescription¶

function hasDescription¶

bool hasDescription() const

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¶

void setWellSampleRef_List(
    const std::vector< Inscoper::NBO::WellSampleRefPtr > & value,
    bool validate =true
)

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

std::vector< Inscoper::NBO::WellSampleRefPtr > getWellSampleRef_List() const

Returns the list of WellSampleRef elements.

Return: The list of WellSampleRef elements

No description available in the XSD standard.

function addToWellSampleRef_List¶

void addToWellSampleRef_List(
    const Inscoper::NBO::WellSampleRefPtr & value,
    bool validate =true
)

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

function setAnnotationRef_List¶

void setAnnotationRef_List(
    const std::vector< Inscoper::NBO::AnnotationRefPtr > & value,
    bool validate =true
)

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

std::vector< Inscoper::NBO::AnnotationRefPtr > getAnnotationRef_List() const

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

void addToAnnotationRef_List(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

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

function fromBase¶

static std::shared_ptr< PlateAcquisition > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a PlateAcquisition.

Parameters:

base The base class to cast

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

function getNameAllowedValues¶

function getEndTimeAllowedValues¶

static const std::set< std::string > & getEndTimeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

Time when the last Image of this Acquisition was collected

function getStartTimeAllowedValues¶

static const std::set< std::string > & getStartTimeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

Time when the first Image of this Acquisition was collected

Updated on 2026-09-23 at 16:50:38 +0200