Inscoper::NBO::ColoredBeadsSlide¶

Represents the XML element ColoredBeadsSlide. More...

#include <ColoredBeadsSlide.h>

Inherits from Inscoper::NBO::OpticalCalibrationStandard_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	ColoredBeadsSlide()
	~ColoredBeadsSlide()
virtual 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	setDate(const std::string & value, bool validate =true) Sets the value of the Date attribute.
std::string	getDate() const Returns the value of the Date attribute.
void	resetDate() Resets the Date attribute to an unset state.
bool	hasDate() const Checks whether the Date attribute is present.
void	setBeadVolume(const float & value, bool validate =true) Sets the value of the BeadVolume attribute.
float	getBeadVolume() const Returns the value of the BeadVolume attribute.
void	resetBeadVolume() Resets the BeadVolume attribute to an unset state.
bool	hasBeadVolume() const Checks whether the BeadVolume attribute is present.
void	setBeadVolumeUnit(const Inscoper::NBO::UnitsVolume_TypePtr & value, bool validate =true) Sets the value of the BeadVolumeUnit attribute.
UnitsVolume_TypePtr	getBeadVolumeUnit() const Returns the value of the BeadVolumeUnit attribute.
void	resetBeadVolumeUnit() Resets the BeadVolumeUnit attribute to an unset state.
bool	hasBeadVolumeUnit() const Checks whether the optional BeadVolumeUnit attribute is present.
void	setColoredBeads(const Inscoper::NBO::ColoredBeadsPtr & value, bool validate =true) Sets the value of the ColoredBeads element.
Inscoper::NBO::ColoredBeadsPtr	getColoredBeads() const Returns the value of the ColoredBeads element.
void	resetColoredBeads() Resets the ColoredBeads element to an unset state.
bool	hasColoredBeads() const Checks whether the optional ColoredBeads element is present.
std::shared_ptr< ColoredBeadsSlide >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a ColoredBeadsSlide.
const std::set< std::string > &	getDateAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::OpticalCalibrationStandard_Type

	Name
	OpticalCalibrationStandard_Type()
	~OpticalCalibrationStandard_Type()
void	setID(const Inscoper::NBO::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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 Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	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 optional Name attribute is present.
void	setMethod(const std::string & value, bool validate =true) Sets the value of the Method attribute.
std::string	getMethod() const Returns the value of the Method attribute.
void	resetMethod() Resets the Method attribute to an unset state.
bool	hasMethod() const Checks whether the Method attribute is present.
void	setWavelengthRange_List(const std::vector< Inscoper::NBO::WavelengthRangePtr > & value, bool validate =true) Sets the list of WavelengthRange elements.
std::vector< Inscoper::NBO::WavelengthRangePtr >	getWavelengthRange_List() const Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(const Inscoper::NBO::WavelengthRangePtr & value, bool validate =true) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.
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.
const std::set< std::string > &	getMethodAllowedValues() Returns the allowed values for this attribut.

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
	~ManufacturerSpec_Type()
void	setManufacturer(const std::string & value, bool validate =true) Sets the value of the Manufacturer attribute.
std::string	getManufacturer() const Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
bool	hasManufacturer() const Checks whether the Manufacturer attribute is present.
void	setModel(const std::string & value, bool validate =true) Sets the value of the Model attribute.
std::string	getModel() const Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
bool	hasModel() const Checks whether the Model attribute is present.
void	setCatalogNumber(const std::string & value, bool validate =true) Sets the value of the CatalogNumber attribute.
std::string	getCatalogNumber() const Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
bool	hasCatalogNumber() const Checks whether the CatalogNumber attribute is present.
void	setLotNumber(const std::string & value, bool validate =true) Sets the value of the LotNumber attribute.
std::string	getLotNumber() const Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
bool	hasLotNumber() const Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true) Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr	getSpecsFile() const Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
bool	hasSpecsFile() const Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
const std::set< std::string > &	getManufacturerAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getModelAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::ColoredBeadsSlide;

Represents the XML element ColoredBeadsSlide.

This element describes a Slide coated with Multicolor Fluorescent Microspheres (also known as Multicolored Beads) used for assessing the Optical properties of the Microscope that was used to acquire this experimental Image. These Slides can be used to measure Optical properties such as resolution, chromatic registration, and different kinds of optical distorsions.

Public Functions Documentation¶

function ColoredBeadsSlide¶

function ~ColoredBeadsSlide¶

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

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

Sets the value of the Date attribute.

Parameters:

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

This field captures the Date in which this Colored Beads Slide was prepared.

function getDate¶

function resetDate¶

function hasDate¶

bool hasDate() const

Checks whether the Date attribute is present.

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

This field captures the Date in which this Colored Beads Slide was prepared.

function setBeadVolume¶

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

Sets the value of the BeadVolume attribute.

Parameters:

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

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

function getBeadVolume¶

float getBeadVolume() const

Returns the value of the BeadVolume attribute.

Return: The value of the attribute

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

function resetBeadVolume¶

function hasBeadVolume¶

bool hasBeadVolume() const

Checks whether the BeadVolume attribute is present.

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

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

function setBeadVolumeUnit¶

void setBeadVolumeUnit(
    const Inscoper::NBO::UnitsVolume_TypePtr & value,
    bool validate =true
)

Sets the value of the BeadVolumeUnit 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 getBeadVolumeUnit¶

function resetBeadVolumeUnit¶

function hasBeadVolumeUnit¶

bool hasBeadVolumeUnit() const

Checks whether the optional BeadVolumeUnit attribute is present.

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

No description available in the XSD standard.

function setColoredBeads¶

void setColoredBeads(
    const Inscoper::NBO::ColoredBeadsPtr & value,
    bool validate =true
)

Sets the value of the ColoredBeads 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 getColoredBeads¶

function resetColoredBeads¶

function hasColoredBeads¶

bool hasColoredBeads() const

Checks whether the optional ColoredBeads element is present.

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

No description available in the XSD standard.

function fromBase¶

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

Cast a NBOBaseClass to a ColoredBeadsSlide.

Parameters:

base The base class to cast

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

function getDateAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field captures the Date in which this Colored Beads Slide was prepared.

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