Experiment¶

Bases: NBOBaseClass

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.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`Experiment`	The casted element, or nullptr if the cast fails

`getTypeName()` ¶

Returns the class type name.

Returns:

Type	Description
`string`	The class type name

`getXMLName()` ¶

Returns the XML element name corresponding to this class.

Returns:

Type	Description
`string`	The XML element name

`getNBOType()` ¶

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
`int`	The NBO Type value

`getChildren()` ¶

Returns a list of all classes derived from this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of derived classes

`getSubElements()` ¶

Returns a list of all child elements contained in this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of child classes

`fromJsonFile(path, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

A unique identifier for this Experiment.

Parameters:

Name	Type	Description	Default
`value`	`ExperimentID_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getID()` ¶

Returns the value of the ID attribute.

A unique identifier for this Experiment.

Returns:

Type	Description
`ExperimentID_Type`	The value of the attribute

`resetID()` ¶

Resets the ID attribute to an unset state.

A unique identifier for this Experiment.

`hasID()` ¶

Checks whether the optional ID attribute is present.

A unique identifier for this Experiment.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setName(value, validate=True)` ¶

Sets the value of the Name attribute.

A user assigned name for this Experiment.

Parameters:

Name	Type	Description	Default
`value`	`Denomination_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getName()` ¶

Returns the value of the Name attribute.

A user assigned name for this Experiment.

Returns:

Type	Description
`Denomination_Type`	The value of the attribute

`resetName()` ¶

Resets the Name attribute to an unset state.

A user assigned name for this Experiment.

`hasName()` ¶

Checks whether the optional Name attribute is present.

A user assigned name for this Experiment.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setPurpose(value, validate=True)` ¶

Sets the value of the Purpose attribute.

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

Parameters:

Name	Type	Description	Default
`value`	`ExperimentPurpose_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getPurpose()` ¶

Returns the value of the Purpose attribute.

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

Returns:

Type	Description
`ExperimentPurpose_Type`	The value of the attribute

`resetPurpose()` ¶

Resets the Purpose attribute to an unset state.

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

`hasPurpose()` ¶

Checks whether the optional Purpose attribute is present.

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

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setLabellingMethod(value, validate=True)` ¶

Sets the value of the LabellingMethod 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.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getLabellingMethod()` ¶

Returns the value of the LabellingMethod 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.

Returns:

Type	Description
`string`	The value of the attribute

`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.

`hasLabellingMethod()` ¶

Checks whether the LabellingMethod attribute is present.

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.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getLabellingMethodAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

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.

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setLabellingMethodTermAccession(value, validate=True)` ¶

Sets the value of the LabellingMethodTermAccession 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.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getLabellingMethodTermAccession()` ¶

Returns the value of the LabellingMethodTermAccession 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.

Returns:

Type	Description
`string`	The value of the attribute

`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.

`hasLabellingMethodTermAccession()` ¶

Checks whether the LabellingMethodTermAccession attribute is present.

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.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getLabellingMethodTermAccessionAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

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.

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setTag(value, validate=True)` ¶

Sets the value of the Tag 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.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getTag()` ¶

Returns the value of the Tag 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.

Returns:

Type	Description
`string`	The value of the attribute

`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.

`hasTag()` ¶

Checks whether the Tag attribute is present.

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.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getTagAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

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.

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setTagTermAccession(value, validate=True)` ¶

Sets the value of the TagTermAccession 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.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getTagTermAccession()` ¶

Returns the value of the TagTermAccession 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.

Returns:

Type	Description
`string`	The value of the attribute

`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.

`hasTagTermAccession()` ¶

Checks whether the TagTermAccession attribute is present.

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.

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getTagTermAccessionAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

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.

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

`setHystochemistryType(value, validate=True)` ¶

Sets the value of the HystochemistryType attribute.

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

Parameters:

Name	Type	Description	Default
`value`	`HystochemistryType_Type`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getHystochemistryType()` ¶

Returns the value of the HystochemistryType attribute.

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

Returns:

Type	Description
`HystochemistryType_Type`	The value of the attribute

`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.

`hasHystochemistryType()` ¶

Checks whether the optional HystochemistryType attribute is present.

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

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setExperimenterRef_List(value, validate=True)` ¶

Sets the list of ExperimenterRef elements.

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

Parameters:

Name	Type	Description	Default
`value`	`List[ExperimenterRef]`	The new list of ExperimenterRef elements	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getExperimenterRef_List()` ¶

Returns the list of ExperimenterRef elements.

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

Returns:

Type	Description
`List[ExperimenterRef]`	The list of ExperimenterRef elements

`addToExperimenterRef_List(value, validate=True)` ¶

Adds a new ExperimenterRef element to this object.

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

Parameters:

Name	Type	Description	Default
`value`	`ExperimenterRef`	The element to add	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`clearExperimenterRef_List()` ¶

Clear the list of ExperimenterRef.

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