Inscoper::NBO::WellSample¶

Represents the XML element WellSample. More...

#include <WellSample.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	WellSample()
	~WellSample()
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::WellSampleID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
WellSampleID_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	setPositionX(const float & value, bool validate =true) Sets the value of the PositionX attribute.
float	getPositionX() const Returns the value of the PositionX attribute.
void	resetPositionX() Resets the PositionX attribute to an unset state.
bool	hasPositionX() const Checks whether the PositionX attribute is present.
void	setPositionXUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PositionXUnit attribute.
UnitsLength_TypePtr	getPositionXUnit() const Returns the value of the PositionXUnit attribute.
void	resetPositionXUnit() Resets the PositionXUnit attribute to an unset state.
bool	hasPositionXUnit() const Checks whether the optional PositionXUnit attribute is present.
void	setPositionY(const float & value, bool validate =true) Sets the value of the PositionY attribute.
float	getPositionY() const Returns the value of the PositionY attribute.
void	resetPositionY() Resets the PositionY attribute to an unset state.
bool	hasPositionY() const Checks whether the PositionY attribute is present.
void	setPositionYUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PositionYUnit attribute.
UnitsLength_TypePtr	getPositionYUnit() const Returns the value of the PositionYUnit attribute.
void	resetPositionYUnit() Resets the PositionYUnit attribute to an unset state.
bool	hasPositionYUnit() const Checks whether the optional PositionYUnit attribute is present.
void	setTimepoint(const std::string & value, bool validate =true) Sets the value of the Timepoint attribute.
std::string	getTimepoint() const Returns the value of the Timepoint attribute.
void	resetTimepoint() Resets the Timepoint attribute to an unset state.
bool	hasTimepoint() const Checks whether the Timepoint attribute is present.
void	setIndex(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the Index attribute.
NonNegativeInt_TypePtr	getIndex() const Returns the value of the Index attribute.
void	resetIndex() Resets the Index attribute to an unset state.
bool	hasIndex() const Checks whether the optional Index attribute is present.
void	setImageRef(const Inscoper::NBO::ImageRefPtr & value, bool validate =true) Sets the value of the ImageRef element.
Inscoper::NBO::ImageRefPtr	getImageRef() const Returns the value of the ImageRef element.
void	resetImageRef() Resets the ImageRef element to an unset state.
bool	hasImageRef() const Checks whether the optional ImageRef element is present.
std::shared_ptr< WellSample >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a WellSample.
const std::set< std::string > &	getTimepointAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::WellSample;

Represents the XML element WellSample.

WellSample is an individual Image that has been captured within a Well.

Public Functions Documentation¶

function WellSample¶

function ~WellSample¶

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::WellSampleID_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 setPositionX¶

void setPositionX(
    const float & value,
    bool validate =true
)

Sets the value of the PositionX attribute.

Parameters:

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

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function getPositionX¶

float getPositionX() const

Returns the value of the PositionX attribute.

Return: The value of the attribute

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function resetPositionX¶

void resetPositionX()

Resets the PositionX attribute to an unset state.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function hasPositionX¶

bool hasPositionX() const

Checks whether the PositionX attribute is present.

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

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function setPositionXUnit¶

void setPositionXUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the PositionXUnit 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 getPositionXUnit¶

function resetPositionXUnit¶

function hasPositionXUnit¶

bool hasPositionXUnit() const

Checks whether the optional PositionXUnit attribute is present.

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

No description available in the XSD standard.

function setPositionY¶

void setPositionY(
    const float & value,
    bool validate =true
)

Sets the value of the PositionY attribute.

Parameters:

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

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function getPositionY¶

float getPositionY() const

Returns the value of the PositionY attribute.

Return: The value of the attribute

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function resetPositionY¶

void resetPositionY()

Resets the PositionY attribute to an unset state.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function hasPositionY¶

bool hasPositionY() const

Checks whether the PositionY attribute is present.

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

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function setPositionYUnit¶

void setPositionYUnit(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the PositionYUnit 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 getPositionYUnit¶

function resetPositionYUnit¶

function hasPositionYUnit¶

bool hasPositionYUnit() const

Checks whether the optional PositionYUnit attribute is present.

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

No description available in the XSD standard.

function setTimepoint¶

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

Sets the value of the Timepoint attribute.

Parameters:

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

The time-point at which the Image started to be collected

function getTimepoint¶

function resetTimepoint¶

function hasTimepoint¶

function setIndex¶

void setIndex(
    const Inscoper::NBO::NonNegativeInt_TypePtr & value,
    bool validate =true
)

Sets the value of the Index attribute.

Parameters:

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

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function getIndex¶

NonNegativeInt_TypePtr getIndex() const

Returns the value of the Index attribute.

Return: The value of the attribute

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function resetIndex¶

void resetIndex()

Resets the Index attribute to an unset state.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function hasIndex¶

bool hasIndex() const

Checks whether the optional Index attribute is present.

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

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function setImageRef¶

void setImageRef(
    const Inscoper::NBO::ImageRefPtr & value,
    bool validate =true
)

Sets the value of the ImageRef element.

Parameters:

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

This is the main link to the core Image element

function getImageRef¶

function resetImageRef¶

function hasImageRef¶

bool hasImageRef() const

Checks whether the optional ImageRef element is present.

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

This is the main link to the core Image element

function fromBase¶

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

Cast a NBOBaseClass to a WellSample.

Parameters:

base The base class to cast

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

function getTimepointAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

The time-point at which the Image started to be collected

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