Inscoper::NBO::Well¶

Represents the XML element Well. More...

#include <Well.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	Well()
	~Well()
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::WellID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
WellID_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	setColumn(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the Column attribute.
NonNegativeInt_TypePtr	getColumn() const Returns the value of the Column attribute.
void	resetColumn() Resets the Column attribute to an unset state.
bool	hasColumn() const Checks whether the optional Column attribute is present.
void	setRow(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the Row attribute.
NonNegativeInt_TypePtr	getRow() const Returns the value of the Row attribute.
void	resetRow() Resets the Row attribute to an unset state.
bool	hasRow() const Checks whether the optional Row attribute is present.
void	setExternalDescription(const std::string & value, bool validate =true) Sets the value of the ExternalDescription attribute.
std::string	getExternalDescription() const Returns the value of the ExternalDescription attribute.
void	resetExternalDescription() Resets the ExternalDescription attribute to an unset state.
bool	hasExternalDescription() const Checks whether the ExternalDescription attribute is present.
void	setExternalIdentifier(const std::string & value, bool validate =true) Sets the value of the ExternalIdentifier attribute.
std::string	getExternalIdentifier() const Returns the value of the ExternalIdentifier attribute.
void	resetExternalIdentifier() Resets the ExternalIdentifier attribute to an unset state.
bool	hasExternalIdentifier() const Checks whether the ExternalIdentifier attribute is present.
void	setType(const std::string & value, bool validate =true) Sets the value of the Type attribute.
std::string	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the Type attribute is present.
void	setColor(const Inscoper::NBO::Color_TypePtr & value, bool validate =true) Sets the value of the Color attribute.
Color_TypePtr	getColor() const Returns the value of the Color attribute.
void	resetColor() Resets the Color attribute to an unset state.
bool	hasColor() const Checks whether the optional Color attribute is present.
void	setWellSample_List(const std::vector< Inscoper::NBO::WellSamplePtr > & value, bool validate =true) Sets the list of WellSample elements.
std::vector< Inscoper::NBO::WellSamplePtr >	getWellSample_List() const Returns the list of WellSample elements.
void	addToWellSample_List(const Inscoper::NBO::WellSamplePtr & value, bool validate =true) Adds a new WellSample element to this object.
void	clearWellSample_List() Clear the list of WellSample.
void	setReagentRef(const Inscoper::NBO::ReagentRefPtr & value, bool validate =true) Sets the value of the ReagentRef element.
Inscoper::NBO::ReagentRefPtr	getReagentRef() const Returns the value of the ReagentRef element.
void	resetReagentRef() Resets the ReagentRef element to an unset state.
bool	hasReagentRef() const Checks whether the optional ReagentRef element is present.
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< Well >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Well.
const std::set< std::string > &	getExternalDescriptionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getExternalIdentifierAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getTypeAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Well;

Represents the XML element Well.

A Well is a component of the Well/Plate/Screen construct to describe screening applications. A Well has a number of WellSample elements that link to the Images collected in this well. The ReagentRef links any Reagents that were used in this Well. A well is part of only one Plate. The origin for the row and column identifiers is the top left corner of the plate starting at zero. i.e The top left well of a plate is index (0,0)

Public Functions Documentation¶

function Well¶

function ~Well¶

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::WellID_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 setColumn¶

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

Sets the value of the Column attribute.

Parameters:

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

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function getColumn¶

NonNegativeInt_TypePtr getColumn() const

Returns the value of the Column attribute.

Return: The value of the attribute

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function resetColumn¶

void resetColumn()

Resets the Column attribute to an unset state.

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function hasColumn¶

bool hasColumn() const

Checks whether the optional Column attribute is present.

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

This is the column index of the well, the origin is the top left corner of the plate with the first column of cells being column zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function setRow¶

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

Sets the value of the Row attribute.

Parameters:

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

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function getRow¶

NonNegativeInt_TypePtr getRow() const

Returns the value of the Row attribute.

Return: The value of the attribute

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function resetRow¶

void resetRow()

Resets the Row attribute to an unset state.

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function hasRow¶

bool hasRow() const

Checks whether the optional Row attribute is present.

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

This is the row index of the well, the origin is the top left corner of the plate with the first row of wells being row zero. i.e top left is (0,0) The combination of Row, Column has to be unique for each well in a plate.

function setExternalDescription¶

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

Sets the value of the ExternalDescription attribute.

Parameters:

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

A description of the externally defined identifier for this plate.

function getExternalDescription¶

std::string getExternalDescription() const

Returns the value of the ExternalDescription attribute.

Return: The value of the attribute

A description of the externally defined identifier for this plate.

function resetExternalDescription¶

function hasExternalDescription¶

bool hasExternalDescription() const

Checks whether the ExternalDescription attribute is present.

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

A description of the externally defined identifier for this plate.

function setExternalIdentifier¶

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

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

std::string getExternalIdentifier() const

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¶

function hasExternalIdentifier¶

bool hasExternalIdentifier() const

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

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

Sets the value of the Type 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 getType¶

function resetType¶

function hasType¶

function setColor¶

void setColor(
    const Inscoper::NBO::Color_TypePtr & value,
    bool validate =true
)

Sets the value of the Color 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 getColor¶

function resetColor¶

function hasColor¶

function setWellSample_List¶

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

Sets the list of WellSample elements.

Parameters:

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

No description available in the XSD standard.

function getWellSample_List¶

std::vector< Inscoper::NBO::WellSamplePtr > getWellSample_List() const

Returns the list of WellSample elements.

Return: The list of WellSample elements

No description available in the XSD standard.

function addToWellSample_List¶

void addToWellSample_List(
    const Inscoper::NBO::WellSamplePtr & value,
    bool validate =true
)

Adds a new WellSample 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 clearWellSample_List¶

function setReagentRef¶

void setReagentRef(
    const Inscoper::NBO::ReagentRefPtr & value,
    bool validate =true
)

Sets the value of the ReagentRef element.

Parameters:

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

No description available in the XSD standard.

function getReagentRef¶

function resetReagentRef¶

function hasReagentRef¶

bool hasReagentRef() const

Checks whether the optional ReagentRef element is present.

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

No description available in the XSD standard.

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< Well > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Well.

Parameters:

base The base class to cast

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

function getExternalDescriptionAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

A description of the externally defined identifier for this plate.

function getExternalIdentifierAllowedValues¶

static const std::set< std::string > & 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.

function getTypeAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

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