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.

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)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

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

setID(value)

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

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)

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

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)

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

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)

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

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

setLabellingMethodTermAccession(value)

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

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 optional 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 optional attribute has been set, false otherwise

setTag(value)

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

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 optional 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 optional attribute has been set, false otherwise

setTagTermAccession(value)

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

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 optional 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 optional attribute has been set, false otherwise

setHystochemistryType(value)

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

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)

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

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)

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

clearExperimenterRef_List()

Clear the list of ExperimenterRef.

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

setSample_List(value)

Sets the list of Sample elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[Sample]	The new list of Sample elements	required

getSample_List()

Returns the list of Sample elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Sample]	The list of Sample elements

addToSample_List(value)

Adds a new Sample element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Sample	The element to add	required

clearSample_List()

Clear the list of Sample.

No description available in the XSD standard.

setMicrobeamManipulation_List(value)

Sets the list of MicrobeamManipulation elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[MicrobeamManipulation]	The new list of MicrobeamManipulation elements	required

getMicrobeamManipulation_List()

Returns the list of MicrobeamManipulation elements.

No description available in the XSD standard.

Returns:

Type	Description
List[MicrobeamManipulation]	The list of MicrobeamManipulation elements

addToMicrobeamManipulation_List(value)

Adds a new MicrobeamManipulation element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	MicrobeamManipulation	The element to add	required

clearMicrobeamManipulation_List()

Clear the list of MicrobeamManipulation.

No description available in the XSD standard.

setDescription(value)

Sets the value of the Description element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	Description	The value to set	required

getDescription()

Returns the value of the Description element.

No description available in the XSD standard.

Returns:

Type	Description
Description	The value of the element

resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

hasDescription()

Checks whether the optional Description element is present.

No description available in the XSD standard.

Returns:

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

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

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

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

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

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

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

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

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

Returns:

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