Inscoper::NBO::Fluorophore¶

Represents the XML element Fluorophore. More...

#include <Fluorophore.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	Fluorophore()
	~Fluorophore()
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::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	setType(const Inscoper::NBO::FluorescentLabelType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
FluorescentLabelType_TypePtr	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 optional Type attribute is present.
void	setExcitationWavelength(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the ExcitationWavelength attribute.
PositiveFloat_TypePtr	getExcitationWavelength() const Returns the value of the ExcitationWavelength attribute.
void	resetExcitationWavelength() Resets the ExcitationWavelength attribute to an unset state.
bool	hasExcitationWavelength() const Checks whether the optional ExcitationWavelength attribute is present.
void	setExcitationWavelengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ExcitationWavelengthUnit attribute.
UnitsLength_TypePtr	getExcitationWavelengthUnit() const Returns the value of the ExcitationWavelengthUnit attribute.
void	resetExcitationWavelengthUnit() Resets the ExcitationWavelengthUnit attribute to an unset state.
bool	hasExcitationWavelengthUnit() const Checks whether the optional ExcitationWavelengthUnit attribute is present.
void	setEmissionWavelength(const Inscoper::NBO::PositiveFloat_TypePtr & value, bool validate =true) Sets the value of the EmissionWavelength attribute.
PositiveFloat_TypePtr	getEmissionWavelength() const Returns the value of the EmissionWavelength attribute.
void	resetEmissionWavelength() Resets the EmissionWavelength attribute to an unset state.
bool	hasEmissionWavelength() const Checks whether the optional EmissionWavelength attribute is present.
void	setEmissionWavelengthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the EmissionWavelengthUnit attribute.
UnitsLength_TypePtr	getEmissionWavelengthUnit() const Returns the value of the EmissionWavelengthUnit attribute.
void	resetEmissionWavelengthUnit() Resets the EmissionWavelengthUnit attribute to an unset state.
bool	hasEmissionWavelengthUnit() const Checks whether the optional EmissionWavelengthUnit attribute is present.
void	setConcentration(const float & value, bool validate =true) Sets the value of the Concentration attribute.
float	getConcentration() const Returns the value of the Concentration attribute.
void	resetConcentration() Resets the Concentration attribute to an unset state.
bool	hasConcentration() const Checks whether the Concentration attribute is present.
void	setConcentrationUnit(const Inscoper::NBO::UnitsConcentration_TypePtr & value, bool validate =true) Sets the value of the ConcentrationUnit attribute.
UnitsConcentration_TypePtr	getConcentrationUnit() const Returns the value of the ConcentrationUnit attribute.
void	resetConcentrationUnit() Resets the ConcentrationUnit attribute to an unset state.
bool	hasConcentrationUnit() const Checks whether the optional ConcentrationUnit attribute is present.
void	setFBBaseID(const std::string & value, bool validate =true) Sets the value of the FBBaseID attribute.
std::string	getFBBaseID() const Returns the value of the FBBaseID attribute.
void	resetFBBaseID() Resets the FBBaseID attribute to an unset state.
bool	hasFBBaseID() const Checks whether the FBBaseID attribute is present.
void	setPrimaryPublicationID(const std::string & value, bool validate =true) Sets the value of the PrimaryPublicationID attribute.
std::string	getPrimaryPublicationID() const Returns the value of the PrimaryPublicationID attribute.
void	resetPrimaryPublicationID() Resets the PrimaryPublicationID attribute to an unset state.
bool	hasPrimaryPublicationID() const Checks whether the PrimaryPublicationID attribute is present.
std::shared_ptr< Fluorophore >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Fluorophore.
const std::set< std::string > &	getFBBaseIDAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getPrimaryPublicationIDAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

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::Fluorophore;

Represents the XML element Fluorophore.

This element describes the Fluorophore whose Emission is used to produce this Channel. [plain text string].

Public Functions Documentation¶

function Fluorophore¶

function ~Fluorophore¶

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::LSID_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.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & 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.

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

function getName¶

Denomination_TypePtr getName() const

Returns the value of the Name attribute.

Return: The value of the attribute

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

function resetName¶

void resetName()

Resets the Name attribute to an unset state.

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

function hasName¶

bool hasName() const

Checks whether the optional Name attribute is present.

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

This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.

function setType¶

void setType(
    const Inscoper::NBO::FluorescentLabelType_TypePtr & 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.

This field records a term that describes the general category of the Fluorescent Label used in this case.

function getType¶

FluorescentLabelType_TypePtr getType() const

Returns the value of the Type attribute.

Return: The value of the attribute

This field records a term that describes the general category of the Fluorescent Label used in this case.

function resetType¶

function hasType¶

bool hasType() const

Checks whether the optional Type attribute is present.

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

This field records a term that describes the general category of the Fluorescent Label used in this case.

function setExcitationWavelength¶

void setExcitationWavelength(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the ExcitationWavelength attribute.

Parameters:

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

This field records the Excitation Wavelength used for this Channel.

function getExcitationWavelength¶

PositiveFloat_TypePtr getExcitationWavelength() const

Returns the value of the ExcitationWavelength attribute.

Return: The value of the attribute

This field records the Excitation Wavelength used for this Channel.

function resetExcitationWavelength¶

function hasExcitationWavelength¶

bool hasExcitationWavelength() const

Checks whether the optional ExcitationWavelength attribute is present.

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

This field records the Excitation Wavelength used for this Channel.

function setExcitationWavelengthUnit¶

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

Sets the value of the ExcitationWavelengthUnit 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 getExcitationWavelengthUnit¶

UnitsLength_TypePtr getExcitationWavelengthUnit() const

Returns the value of the ExcitationWavelengthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetExcitationWavelengthUnit¶

function hasExcitationWavelengthUnit¶

bool hasExcitationWavelengthUnit() const

Checks whether the optional ExcitationWavelengthUnit attribute is present.

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

No description available in the XSD standard.

function setEmissionWavelength¶

void setEmissionWavelength(
    const Inscoper::NBO::PositiveFloat_TypePtr & value,
    bool validate =true
)

Sets the value of the EmissionWavelength attribute.

Parameters:

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

This field records the Emission Wavelength used for this Channel.

function getEmissionWavelength¶

PositiveFloat_TypePtr getEmissionWavelength() const

Returns the value of the EmissionWavelength attribute.

Return: The value of the attribute

This field records the Emission Wavelength used for this Channel.

function resetEmissionWavelength¶

function hasEmissionWavelength¶

bool hasEmissionWavelength() const

Checks whether the optional EmissionWavelength attribute is present.

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

This field records the Emission Wavelength used for this Channel.

function setEmissionWavelengthUnit¶

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

Sets the value of the EmissionWavelengthUnit 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 getEmissionWavelengthUnit¶

function resetEmissionWavelengthUnit¶

function hasEmissionWavelengthUnit¶

bool hasEmissionWavelengthUnit() const

Checks whether the optional EmissionWavelengthUnit attribute is present.

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

No description available in the XSD standard.

function setConcentration¶

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

Sets the value of the Concentration attribute.

Parameters:

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

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

function getConcentration¶

float getConcentration() const

Returns the value of the Concentration attribute.

Return: The value of the attribute

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

function resetConcentration¶

void resetConcentration()

Resets the Concentration attribute to an unset state.

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

function hasConcentration¶

bool hasConcentration() const

Checks whether the Concentration attribute is present.

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

If applicable (e.g., in the case of direct incubation of the sample with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.

function setConcentrationUnit¶

void setConcentrationUnit(
    const Inscoper::NBO::UnitsConcentration_TypePtr & value,
    bool validate =true
)

Sets the value of the ConcentrationUnit 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 getConcentrationUnit¶

function resetConcentrationUnit¶

function hasConcentrationUnit¶

bool hasConcentrationUnit() const

Checks whether the optional ConcentrationUnit attribute is present.

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

No description available in the XSD standard.

function setFBBaseID¶

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

Sets the value of the FBBaseID attribute.

Parameters:

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

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

function getFBBaseID¶

std::string getFBBaseID() const

Returns the value of the FBBaseID attribute.

Return: The value of the attribute

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

function resetFBBaseID¶

function hasFBBaseID¶

bool hasFBBaseID() const

Checks whether the FBBaseID attribute is present.

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

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

function setPrimaryPublicationID¶

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

Sets the value of the PrimaryPublicationID attribute.

Parameters:

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

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

function getPrimaryPublicationID¶

std::string getPrimaryPublicationID() const

Returns the value of the PrimaryPublicationID attribute.

Return: The value of the attribute

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

function resetPrimaryPublicationID¶

void resetPrimaryPublicationID()

Resets the PrimaryPublicationID attribute to an unset state.

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

function hasPrimaryPublicationID¶

bool hasPrimaryPublicationID() const

Checks whether the PrimaryPublicationID attribute is present.

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

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

function fromBase¶

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

Cast a NBOBaseClass to a Fluorophore.

Parameters:

base The base class to cast

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

function getFBBaseIDAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).

function getPrimaryPublicationIDAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

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