Inscoper::NBO::Experiment¶

Represents the XML element Experiment. More...

#include <Experiment.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	Experiment()
	~Experiment()
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::ExperimentID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ExperimentID_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	setPurpose(const Inscoper::NBO::ExperimentPurpose_TypePtr & value, bool validate =true) Sets the value of the Purpose attribute.
ExperimentPurpose_TypePtr	getPurpose() const Returns the value of the Purpose attribute.
void	resetPurpose() Resets the Purpose attribute to an unset state.
bool	hasPurpose() const Checks whether the optional Purpose attribute is present.
void	setLabellingMethod(const std::string & value, bool validate =true) Sets the value of the LabellingMethod attribute.
std::string	getLabellingMethod() const Returns the value of the LabellingMethod attribute.
void	resetLabellingMethod() Resets the LabellingMethod attribute to an unset state.
bool	hasLabellingMethod() const Checks whether the LabellingMethod attribute is present.
void	setLabellingMethodTermAccession(const std::string & value, bool validate =true) Sets the value of the LabellingMethodTermAccession attribute.
std::string	getLabellingMethodTermAccession() const Returns the value of the LabellingMethodTermAccession attribute.
void	resetLabellingMethodTermAccession() Resets the LabellingMethodTermAccession attribute to an unset state.
bool	hasLabellingMethodTermAccession() const Checks whether the LabellingMethodTermAccession attribute is present.
void	setTag(const std::string & value, bool validate =true) Sets the value of the Tag attribute.
std::string	getTag() const Returns the value of the Tag attribute.
void	resetTag() Resets the Tag attribute to an unset state.
bool	hasTag() const Checks whether the Tag attribute is present.
void	setTagTermAccession(const std::string & value, bool validate =true) Sets the value of the TagTermAccession attribute.
std::string	getTagTermAccession() const Returns the value of the TagTermAccession attribute.
void	resetTagTermAccession() Resets the TagTermAccession attribute to an unset state.
bool	hasTagTermAccession() const Checks whether the TagTermAccession attribute is present.
void	setHystochemistryType(const Inscoper::NBO::HystochemistryType_TypePtr & value, bool validate =true) Sets the value of the HystochemistryType attribute.
HystochemistryType_TypePtr	getHystochemistryType() const Returns the value of the HystochemistryType attribute.
void	resetHystochemistryType() Resets the HystochemistryType attribute to an unset state.
bool	hasHystochemistryType() const Checks whether the optional HystochemistryType attribute is present.
void	setExperimenterRef_List(const std::vector< Inscoper::NBO::ExperimenterRefPtr > & value, bool validate =true) Sets the list of ExperimenterRef elements.
std::vector< Inscoper::NBO::ExperimenterRefPtr >	getExperimenterRef_List() const Returns the list of ExperimenterRef elements.
void	addToExperimenterRef_List(const Inscoper::NBO::ExperimenterRefPtr & value, bool validate =true) Adds a new ExperimenterRef element to this object.
void	clearExperimenterRef_List() Clear the list of ExperimenterRef.
void	setSample_List(const std::vector< Inscoper::NBO::SamplePtr > & value, bool validate =true) Sets the list of Sample elements.
std::vector< Inscoper::NBO::SamplePtr >	getSample_List() const Returns the list of Sample elements.
void	addToSample_List(const Inscoper::NBO::SamplePtr & value, bool validate =true) Adds a new Sample element to this object.
void	clearSample_List() Clear the list of Sample.
void	setMicrobeamManipulation_List(const std::vector< Inscoper::NBO::MicrobeamManipulationPtr > & value, bool validate =true) Sets the list of MicrobeamManipulation elements.
std::vector< Inscoper::NBO::MicrobeamManipulationPtr >	getMicrobeamManipulation_List() const Returns the list of MicrobeamManipulation elements.
void	addToMicrobeamManipulation_List(const Inscoper::NBO::MicrobeamManipulationPtr & value, bool validate =true) Adds a new MicrobeamManipulation element to this object.
void	clearMicrobeamManipulation_List() Clear the list of MicrobeamManipulation.
void	setDescription(const Inscoper::NBO::DescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::DescriptionPtr	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	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< Experiment >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Experiment.
const std::set< std::string > &	getLabellingMethodAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLabellingMethodTermAccessionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getTagAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getTagTermAccessionAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Experiment;

Represents the XML element Experiment.

This element describes the experiment during which this Image was acquired. The optional Description element may contain free text to further describe the experiment.

Public Functions Documentation¶

function Experiment¶

function ~Experiment¶

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::ExperimentID_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 Experiment.

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.

A user assigned name for this Experiment.

function getName¶

function resetName¶

function hasName¶

function setPurpose¶

void setPurpose(
    const Inscoper::NBO::ExperimentPurpose_TypePtr & value,
    bool validate =true
)

Sets the value of the Purpose attribute.

Parameters:

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

This field records a term used the general purpose of the imaging experiment performed in this case.

function getPurpose¶

ExperimentPurpose_TypePtr getPurpose() const

Returns the value of the Purpose attribute.

Return: The value of the attribute

This field records a term used the general purpose of the imaging experiment performed in this case.

function resetPurpose¶

function hasPurpose¶

bool hasPurpose() const

Checks whether the optional Purpose attribute is present.

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

This field records a term used the general purpose of the imaging experiment performed in this case.

function setLabellingMethod¶

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

Sets the value of the LabellingMethod 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 method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function getLabellingMethod¶

std::string getLabellingMethod() const

Returns the value of the LabellingMethod attribute.

Return: The value of the attribute

This field records a term that describes the method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function resetLabellingMethod¶

void resetLabellingMethod()

Resets the LabellingMethod attribute to an unset state.

This field records a term that describes the method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function hasLabellingMethod¶

bool hasLabellingMethod() const

Checks whether the LabellingMethod attribute is present.

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

This field records a term that describes the method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function setLabellingMethodTermAccession¶

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

Sets the value of the LabellingMethodTermAccession attribute.

Parameters:

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

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function getLabellingMethodTermAccession¶

std::string getLabellingMethodTermAccession() const

Returns the value of the LabellingMethodTermAccession attribute.

Return: The value of the attribute

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function resetLabellingMethodTermAccession¶

void resetLabellingMethodTermAccession()

Resets the LabellingMethodTermAccession attribute to an unset state.

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function hasLabellingMethodTermAccession¶

bool hasLabellingMethodTermAccession() const

Checks whether the LabellingMethodTermAccession attribute is present.

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

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function setTag¶

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

Sets the value of the Tag attribute.

Parameters:

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

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function getTag¶

std::string getTag() const

Returns the value of the Tag attribute.

Return: The value of the attribute

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function resetTag¶

void resetTag()

Resets the Tag attribute to an unset state.

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function hasTag¶

bool hasTag() const

Checks whether the Tag attribute is present.

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

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function setTagTermAccession¶

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

Sets the value of the TagTermAccession attribute.

Parameters:

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

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function getTagTermAccession¶

std::string getTagTermAccession() const

Returns the value of the TagTermAccession attribute.

Return: The value of the attribute

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function resetTagTermAccession¶

void resetTagTermAccession()

Resets the TagTermAccession attribute to an unset state.

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function hasTagTermAccession¶

bool hasTagTermAccession() const

Checks whether the TagTermAccession attribute is present.

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

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function setHystochemistryType¶

void setHystochemistryType(
    const Inscoper::NBO::HystochemistryType_TypePtr & value,
    bool validate =true
)

Sets the value of the HystochemistryType 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 Histochemistry staining used in this case.

function getHystochemistryType¶

HystochemistryType_TypePtr getHystochemistryType() const

Returns the value of the HystochemistryType attribute.

Return: The value of the attribute

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

function resetHystochemistryType¶

void resetHystochemistryType()

Resets the HystochemistryType attribute to an unset state.

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

function hasHystochemistryType¶

bool hasHystochemistryType() const

Checks whether the optional HystochemistryType 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 Histochemistry staining used in this case.

function setExperimenterRef_List¶

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

Sets the list of ExperimenterRef elements.

Parameters:

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

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function getExperimenterRef_List¶

std::vector< Inscoper::NBO::ExperimenterRefPtr > getExperimenterRef_List() const

Returns the list of ExperimenterRef elements.

Return: The list of ExperimenterRef elements

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function addToExperimenterRef_List¶

void addToExperimenterRef_List(
    const Inscoper::NBO::ExperimenterRefPtr & value,
    bool validate =true
)

Adds a new ExperimenterRef element to this object.

Parameters:

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

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function clearExperimenterRef_List¶

function setSample_List¶

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

Sets the list of Sample elements.

Parameters:

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

No description available in the XSD standard.

function getSample_List¶

function addToSample_List¶

void addToSample_List(
    const Inscoper::NBO::SamplePtr & value,
    bool validate =true
)

Adds a new Sample 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 clearSample_List¶

function setMicrobeamManipulation_List¶

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

Sets the list of MicrobeamManipulation elements.

Parameters:

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

No description available in the XSD standard.

function getMicrobeamManipulation_List¶

std::vector< Inscoper::NBO::MicrobeamManipulationPtr > getMicrobeamManipulation_List() const

Returns the list of MicrobeamManipulation elements.

Return: The list of MicrobeamManipulation elements

No description available in the XSD standard.

function addToMicrobeamManipulation_List¶

void addToMicrobeamManipulation_List(
    const Inscoper::NBO::MicrobeamManipulationPtr & value,
    bool validate =true
)

Adds a new MicrobeamManipulation 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 clearMicrobeamManipulation_List¶

function setDescription¶

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

No description available in the XSD standard.

function getDescription¶

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

No description available in the XSD standard.

function setAnnotationRef¶

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

Sets the value of the AnnotationRef element.

Parameters:

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

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

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

This is a simple multi-line comment or annotation describing this component.

function fromBase¶

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

Cast a NBOBaseClass to a Experiment.

Parameters:

base The base class to cast

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

function getLabellingMethodAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records a term that describes the method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function getLabellingMethodTermAccessionAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function getTagAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function getTagTermAccessionAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

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