Inscoper::NBO::Sample
Represents the XML element Sample . More...
#include <Sample.h>
Inherits from NBOBaseClass
Public Functions
Name
Sample ()
~Sample ()
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
setBiologicalOrigin (const bool & value, bool validate =true) Sets the value of the BiologicalOrigin attribute.
bool
getBiologicalOrigin () const Returns the value of the BiologicalOrigin attribute.
void
resetBiologicalOrigin () Resets the BiologicalOrigin attribute to an unset state.
bool
hasBiologicalOrigin () const Checks whether the BiologicalOrigin attribute is present.
void
setSampleType (const Inscoper::NBO::SampleType_TypePtr & value, bool validate =true) Sets the value of the SampleType attribute.
SampleType_TypePtr
getSampleType () const Returns the value of the SampleType attribute.
void
resetSampleType () Resets the SampleType attribute to an unset state.
bool
hasSampleType () const Checks whether the optional SampleType attribute is present.
void
setLiveSample (const bool & value, bool validate =true) Sets the value of the LiveSample attribute.
bool
getLiveSample () const Returns the value of the LiveSample attribute.
void
resetLiveSample () Resets the LiveSample attribute to an unset state.
bool
hasLiveSample () const Checks whether the LiveSample attribute is present.
void
setOrganism (const std::string & value, bool validate =true) Sets the value of the Organism attribute.
std::string
getOrganism () const Returns the value of the Organism attribute.
void
resetOrganism () Resets the Organism attribute to an unset state.
bool
hasOrganism () const Checks whether the Organism attribute is present.
void
setOrganismTermAccession (const std::string & value, bool validate =true) Sets the value of the OrganismTermAccession attribute.
std::string
getOrganismTermAccession () const Returns the value of the OrganismTermAccession attribute.
void
resetOrganismTermAccession () Resets the OrganismTermAccession attribute to an unset state.
bool
hasOrganismTermAccession () const Checks whether the OrganismTermAccession attribute is present.
void
setOrganismPart (const std::string & value, bool validate =true) Sets the value of the OrganismPart attribute.
std::string
getOrganismPart () const Returns the value of the OrganismPart attribute.
void
resetOrganismPart () Resets the OrganismPart attribute to an unset state.
bool
hasOrganismPart () const Checks whether the OrganismPart attribute is present.
void
setOrganismPartTermAccession (const std::string & value, bool validate =true) Sets the value of the OrganismPartTermAccession attribute.
std::string
getOrganismPartTermAccession () const Returns the value of the OrganismPartTermAccession attribute.
void
resetOrganismPartTermAccession () Resets the OrganismPartTermAccession attribute to an unset state.
bool
hasOrganismPartTermAccession () const Checks whether the OrganismPartTermAccession attribute is present.
void
setSamplePreparationMethod (const std::string & value, bool validate =true) Sets the value of the SamplePreparationMethod attribute.
std::string
getSamplePreparationMethod () const Returns the value of the SamplePreparationMethod attribute.
void
resetSamplePreparationMethod () Resets the SamplePreparationMethod attribute to an unset state.
bool
hasSamplePreparationMethod () const Checks whether the SamplePreparationMethod attribute is present.
void
setSamplePreparationMethodTermAccession (const std::string & value, bool validate =true) Sets the value of the SamplePreparationMethodTermAccession attribute.
std::string
getSamplePreparationMethodTermAccession () const Returns the value of the SamplePreparationMethodTermAccession attribute.
void
resetSamplePreparationMethodTermAccession () Resets the SamplePreparationMethodTermAccession attribute to an unset state.
bool
hasSamplePreparationMethodTermAccession () const Checks whether the SamplePreparationMethodTermAccession attribute is present.
void
setMetrologySample (const bool & value, bool validate =true) Sets the value of the MetrologySample attribute.
bool
getMetrologySample () const Returns the value of the MetrologySample attribute.
void
resetMetrologySample () Resets the MetrologySample attribute to an unset state.
bool
hasMetrologySample () const Checks whether the MetrologySample attribute is present.
void
setFacingTheObjective (const Inscoper::NBO::FacingTheObjectiveChoice_TypePtr & value, bool validate =true) Sets the value of the FacingTheObjective attribute.
FacingTheObjectiveChoice_TypePtr
getFacingTheObjective () const Returns the value of the FacingTheObjective attribute.
void
resetFacingTheObjective () Resets the FacingTheObjective attribute to an unset state.
bool
hasFacingTheObjective () const Checks whether the optional FacingTheObjective attribute is present.
void
setMountingMedium_List (const std::vector< Inscoper::NBO::MountingMediumPtr > & value, bool validate =true) Sets the list of MountingMedium elements.
std::vector< Inscoper::NBO::MountingMediumPtr >
getMountingMedium_List () const Returns the list of MountingMedium elements.
void
addToMountingMedium_List (const Inscoper::NBO::MountingMediumPtr & value, bool validate =true) Adds a new MountingMedium element to this object.
void
clearMountingMedium_List () Clear the list of MountingMedium .
void
setCoverGlass_List (const std::vector< Inscoper::NBO::CoverGlassPtr > & value, bool validate =true) Sets the list of CoverGlass elements.
std::vector< Inscoper::NBO::CoverGlassPtr >
getCoverGlass_List () const Returns the list of CoverGlass elements.
void
addToCoverGlass_List (const Inscoper::NBO::CoverGlassPtr & value, bool validate =true) Adds a new CoverGlass element to this object.
void
clearCoverGlass_List () Clear the list of CoverGlass .
void
setSampleHolder_List (const std::vector< Inscoper::NBO::SampleHolderPtr > & value, bool validate =true) Sets the list of SampleHolder elements.
std::vector< Inscoper::NBO::SampleHolderPtr >
getSampleHolder_List () const Returns the list of SampleHolder elements.
void
addToSampleHolder_List (const Inscoper::NBO::SampleHolderPtr & value, bool validate =true) Adds a new SampleHolder element to this object.
void
clearSampleHolder_List () Clear the list of SampleHolder .
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_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 .
std::shared_ptr< Sample >
fromBase (NBOBaseClassPtr base) Cast a NBOBaseClass to a Sample .
const std::set< std::string > &
getOrganismAllowedValues () Returns the allowed values for this attribut.
const std::set< std::string > &
getOrganismTermAccessionAllowedValues () Returns the allowed values for this attribut.
const std::set< std::string > &
getOrganismPartAllowedValues () Returns the allowed values for this attribut.
const std::set< std::string > &
getOrganismPartTermAccessionAllowedValues () Returns the allowed values for this attribut.
const std::set< std::string > &
getSamplePreparationMethodAllowedValues () Returns the allowed values for this attribut.
const std::set< std::string > &
getSamplePreparationMethodTermAccessionAllowedValues () Returns the allowed values for this attribut.
Detailed Description
class Inscoper :: NBO :: Sample ;
Represents the XML element Sample .
This field captures a description of the sample that was imaged in this experiment.
Public Functions Documentation
function Sample function ~Sample function getTypeName
std :: string getTypeName () const override
Returns the class type name.
Return : The class type name
function getXMLName
std :: string getXMLName () const override
Returns the XML element name corresponding to this class.
Return : The XML element name
function getNBOType
ENBOType getNBOType () const override
Returns the NBO Type corresponding to this class.
Return : The NBO Type value
function getChildren
std :: vector < NBOBaseClassPtr > getChildren () const override
Returns a list of all classes derived from this class.
Return : The list of derived classes
function getSubElements
std :: vector < NBOBaseClassPtr > getSubElements () const override
Returns a list of all child elements contained in this class.
Return : The list of child classes
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 Sample .
function getID
LSID_TypePtr getID () const
Returns the value of the ID attribute.
Return : The value of the attribute
A unique identifier for this Sample .
function resetID
Resets the ID attribute to an unset state.
A unique identifier for this Sample .
function hasID
Checks whether the optional ID attribute is present.
Return : true if the optional attribute has been set, false otherwise
A unique identifier for this Sample .
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 Sample .
function getName
Denomination_TypePtr getName () const
Returns the value of the Name attribute.
Return : The value of the attribute
A user assigned Name for this Sample .
function resetName
Resets the Name attribute to an unset state.
A user assigned Name for this Sample .
function hasName
Checks whether the optional Name attribute is present.
Return : true if the optional attribute has been set, false otherwise
A user assigned Name for this Sample .
function setBiologicalOrigin
void setBiologicalOrigin (
const bool & value ,
bool validate = true
)
Sets the value of the BiologicalOrigin attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
This field captures whether (True) or not (False) this Sample is of Biological Origin.
function getBiologicalOrigin
bool getBiologicalOrigin () const
Returns the value of the BiologicalOrigin attribute.
Return : The value of the attribute
This field captures whether (True) or not (False) this Sample is of Biological Origin.
function resetBiologicalOrigin
void resetBiologicalOrigin ()
Resets the BiologicalOrigin attribute to an unset state.
This field captures whether (True) or not (False) this Sample is of Biological Origin.
function hasBiologicalOrigin
bool hasBiologicalOrigin () const
Checks whether the BiologicalOrigin attribute is present.
Return : true if the attribute has been set, false otherwise
This field captures whether (True) or not (False) this Sample is of Biological Origin.
function setSampleType
void setSampleType (
const Inscoper :: NBO :: SampleType_TypePtr & value ,
bool validate = true
)
Sets the value of the SampleType attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
If of Biological Origin, this field records a term that describes the general category of this Sample .
function getSampleType
SampleType_TypePtr getSampleType () const
Returns the value of the SampleType attribute.
Return : The value of the attribute
If of Biological Origin, this field records a term that describes the general category of this Sample .
function resetSampleType
Resets the SampleType attribute to an unset state.
If of Biological Origin, this field records a term that describes the general category of this Sample .
function hasSampleType
bool hasSampleType () const
Checks whether the optional SampleType attribute is present.
Return : true if the optional attribute has been set, false otherwise
If of Biological Origin, this field records a term that describes the general category of this Sample .
function setLiveSample
void setLiveSample (
const bool & value ,
bool validate = true
)
Sets the value of the LiveSample attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
This field captures whether (True) or not (False) this Sample was living during Image Acquisition.
function getLiveSample
bool getLiveSample () const
Returns the value of the LiveSample attribute.
Return : The value of the attribute
This field captures whether (True) or not (False) this Sample was living during Image Acquisition.
function resetLiveSample
Resets the LiveSample attribute to an unset state.
This field captures whether (True) or not (False) this Sample was living during Image Acquisition.
function hasLiveSample
bool hasLiveSample () const
Checks whether the LiveSample attribute is present.
Return : true if the attribute has been set, false otherwise
This field captures whether (True) or not (False) this Sample was living during Image Acquisition.
function setOrganism
void setOrganism (
const std :: string & value ,
bool validate = true
)
Sets the value of the Organism attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
If this sample is of biological origin, this field records the biological organisn this sample derives from. A biological is a biological entity that consists of one or more cells and is capable of genomic replication (independently or not). The use terms from NCBITaxon (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended. Note: if the sample is not of biological origin please enter none.
function getOrganism
std :: string getOrganism () const
Returns the value of the Organism attribute.
Return : The value of the attribute
If this sample is of biological origin, this field records the biological organisn this sample derives from. A biological is a biological entity that consists of one or more cells and is capable of genomic replication (independently or not). The use terms from NCBITaxon (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended. Note: if the sample is not of biological origin please enter none.
function resetOrganism
Resets the Organism attribute to an unset state.
If this sample is of biological origin, this field records the biological organisn this sample derives from. A biological is a biological entity that consists of one or more cells and is capable of genomic replication (independently or not). The use terms from NCBITaxon (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended. Note: if the sample is not of biological origin please enter none.
function hasOrganism
Checks whether the Organism attribute is present.
Return : true if the attribute has been set, false otherwise
If this sample is of biological origin, this field records the biological organisn this sample derives from. A biological is a biological entity that consists of one or more cells and is capable of genomic replication (independently or not). The use terms from NCBITaxon (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended. Note: if the sample is not of biological origin please enter none.
function setOrganismTermAccession
void setOrganismTermAccession (
const std :: string & value ,
bool validate = true
)
Sets the value of the OrganismTermAccession 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 Organism. The use of the NCBITaxon ontology (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended.
function getOrganismTermAccession
std :: string getOrganismTermAccession () const
Returns the value of the OrganismTermAccession attribute.
Return : The value of the attribute
This field records the Accession ID for the term used to describe the Organism. The use of the NCBITaxon ontology (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended.
function resetOrganismTermAccession
void resetOrganismTermAccession ()
Resets the OrganismTermAccession attribute to an unset state.
This field records the Accession ID for the term used to describe the Organism. The use of the NCBITaxon ontology (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended.
function hasOrganismTermAccession
bool hasOrganismTermAccession () const
Checks whether the OrganismTermAccession 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 Organism. The use of the NCBITaxon ontology (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended.
function setOrganismPart
void setOrganismPart (
const std :: string & value ,
bool validate = true
)
Sets the value of the OrganismPart attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
If applicable, this field records the part of organism's anatomy or substance arising from an organism from which the biomaterial was derived, excludes cells. E.g. tissue, organ, system, sperm, blood or body location (arm). The use of a sub-class of the 'Organism Part' (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function getOrganismPart
std :: string getOrganismPart () const
Returns the value of the OrganismPart attribute.
Return : The value of the attribute
If applicable, this field records the part of organism's anatomy or substance arising from an organism from which the biomaterial was derived, excludes cells. E.g. tissue, organ, system, sperm, blood or body location (arm). The use of a sub-class of the 'Organism Part' (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function resetOrganismPart
Resets the OrganismPart attribute to an unset state.
If applicable, this field records the part of organism's anatomy or substance arising from an organism from which the biomaterial was derived, excludes cells. E.g. tissue, organ, system, sperm, blood or body location (arm). The use of a sub-class of the 'Organism Part' (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function hasOrganismPart
bool hasOrganismPart () const
Checks whether the OrganismPart attribute is present.
Return : true if the attribute has been set, false otherwise
If applicable, this field records the part of organism's anatomy or substance arising from an organism from which the biomaterial was derived, excludes cells. E.g. tissue, organ, system, sperm, blood or body location (arm). The use of a sub-class of the 'Organism Part' (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function setOrganismPartTermAccession
void setOrganismPartTermAccession (
const std :: string & value ,
bool validate = true
)
Sets the value of the OrganismPartTermAccession 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 Organism. A sub-classe of the EFO:0000635 (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function getOrganismPartTermAccession
std :: string getOrganismPartTermAccession () const
Returns the value of the OrganismPartTermAccession attribute.
Return : The value of the attribute
This field records the Accession ID for the term used to describe the Organism. A sub-classe of the EFO:0000635 (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function resetOrganismPartTermAccession
void resetOrganismPartTermAccession ()
Resets the OrganismPartTermAccession attribute to an unset state.
This field records the Accession ID for the term used to describe the Organism. A sub-classe of the EFO:0000635 (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function hasOrganismPartTermAccession
bool hasOrganismPartTermAccession () const
Checks whether the OrganismPartTermAccession 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 Organism. A sub-classe of the EFO:0000635 (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function setSamplePreparationMethod
void setSamplePreparationMethod (
const std :: string & value ,
bool validate = true
)
Sets the value of the SamplePreparationMethod attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
This field records the method that was used to prepare this sample. The use of a sub-class of the 'Sample Preparation Method' (http://purl.obolibrary.org/obo/FBbi_00000001 ) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi ) is recommended.
function getSamplePreparationMethod function resetSamplePreparationMethod function hasSamplePreparationMethod function setSamplePreparationMethodTermAccession
void setSamplePreparationMethodTermAccession (
const std :: string & value ,
bool validate = true
)
Sets the value of the SamplePreparationMethodTermAccession attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
This field records the the Accession ID for the term used to describe method that was used to prepare this sample. A subclass of the Fbbi:00000001 (http://purl.obolibrary.org/obo/FBbi_00000001 ) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi ) is recommended.
function getSamplePreparationMethodTermAccession
std :: string getSamplePreparationMethodTermAccession () const
Returns the value of the SamplePreparationMethodTermAccession attribute.
Return : The value of the attribute
This field records the the Accession ID for the term used to describe method that was used to prepare this sample. A subclass of the Fbbi:00000001 (http://purl.obolibrary.org/obo/FBbi_00000001 ) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi ) is recommended.
function resetSamplePreparationMethodTermAccession
void resetSamplePreparationMethodTermAccession ()
Resets the SamplePreparationMethodTermAccession attribute to an unset state.
This field records the the Accession ID for the term used to describe method that was used to prepare this sample. A subclass of the Fbbi:00000001 (http://purl.obolibrary.org/obo/FBbi_00000001 ) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi ) is recommended.
function hasSamplePreparationMethodTermAccession
bool hasSamplePreparationMethodTermAccession () const
Checks whether the SamplePreparationMethodTermAccession attribute is present.
Return : true if the attribute has been set, false otherwise
This field records the the Accession ID for the term used to describe method that was used to prepare this sample. A subclass of the Fbbi:00000001 (http://purl.obolibrary.org/obo/FBbi_00000001 ) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi ) is recommended.
function setMetrologySample
void setMetrologySample (
const bool & value ,
bool validate = true
)
Sets the value of the MetrologySample attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
This field captures whether (True) or not (False) this is a Metrology Sample (i.e., a Sample that is used specifcially to calibrate and assess the performance of the Instrument utilized for this experimental Image Acquisition.
function getMetrologySample
bool getMetrologySample () const
Returns the value of the MetrologySample attribute.
Return : The value of the attribute
This field captures whether (True) or not (False) this is a Metrology Sample (i.e., a Sample that is used specifcially to calibrate and assess the performance of the Instrument utilized for this experimental Image Acquisition.
function resetMetrologySample
void resetMetrologySample ()
Resets the MetrologySample attribute to an unset state.
This field captures whether (True) or not (False) this is a Metrology Sample (i.e., a Sample that is used specifcially to calibrate and assess the performance of the Instrument utilized for this experimental Image Acquisition.
function hasMetrologySample
bool hasMetrologySample () const
Checks whether the MetrologySample attribute is present.
Return : true if the attribute has been set, false otherwise
This field captures whether (True) or not (False) this is a Metrology Sample (i.e., a Sample that is used specifcially to calibrate and assess the performance of the Instrument utilized for this experimental Image Acquisition.
function setFacingTheObjective
void setFacingTheObjective (
const Inscoper :: NBO :: FacingTheObjectiveChoice_TypePtr & value ,
bool validate = true
)
Sets the value of the FacingTheObjective attribute.
Parameters :
value The value to set
validate If true, validates constraints on value. Default is true.
This field captures whether the CoverGlass , the SampleHolder , or neither (None), faced the Objective during Acquisition of this Image .
function getFacingTheObjective
FacingTheObjectiveChoice_TypePtr getFacingTheObjective () const
Returns the value of the FacingTheObjective attribute.
Return : The value of the attribute
This field captures whether the CoverGlass , the SampleHolder , or neither (None), faced the Objective during Acquisition of this Image .
function resetFacingTheObjective
void resetFacingTheObjective ()
Resets the FacingTheObjective attribute to an unset state.
This field captures whether the CoverGlass , the SampleHolder , or neither (None), faced the Objective during Acquisition of this Image .
function hasFacingTheObjective
bool hasFacingTheObjective () const
Checks whether the optional FacingTheObjective attribute is present.
Return : true if the optional attribute has been set, false otherwise
This field captures whether the CoverGlass , the SampleHolder , or neither (None), faced the Objective during Acquisition of this Image .
function setMountingMedium_List
void setMountingMedium_List (
const std :: vector < Inscoper :: NBO :: MountingMediumPtr > & value ,
bool validate = true
)
Sets the list of MountingMedium elements.
Parameters :
value The new list of MountingMedium elements
validate If true, validates constraints on value. Default is true.
No description available in the XSD standard.
function getMountingMedium_List
std :: vector < Inscoper :: NBO :: MountingMediumPtr > getMountingMedium_List () const
Returns the list of MountingMedium elements.
Return : The list of MountingMedium elements
No description available in the XSD standard.
function addToMountingMedium_List
void addToMountingMedium_List (
const Inscoper :: NBO :: MountingMediumPtr & value ,
bool validate = true
)
Adds a new MountingMedium 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 clearMountingMedium_List
void clearMountingMedium_List ()
Clear the list of MountingMedium .
No description available in the XSD standard.
function setCoverGlass_List
void setCoverGlass_List (
const std :: vector < Inscoper :: NBO :: CoverGlassPtr > & value ,
bool validate = true
)
Sets the list of CoverGlass elements.
Parameters :
value The new list of CoverGlass elements
validate If true, validates constraints on value. Default is true.
No description available in the XSD standard.
function getCoverGlass_List
std :: vector < Inscoper :: NBO :: CoverGlassPtr > getCoverGlass_List () const
Returns the list of CoverGlass elements.
Return : The list of CoverGlass elements
No description available in the XSD standard.
function addToCoverGlass_List
void addToCoverGlass_List (
const Inscoper :: NBO :: CoverGlassPtr & value ,
bool validate = true
)
Adds a new CoverGlass 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 clearCoverGlass_List
void clearCoverGlass_List ()
Clear the list of CoverGlass .
No description available in the XSD standard.
function setSampleHolder_List
void setSampleHolder_List (
const std :: vector < Inscoper :: NBO :: SampleHolderPtr > & value ,
bool validate = true
)
Sets the list of SampleHolder elements.
Parameters :
value The new list of SampleHolder elements
validate If true, validates constraints on value. Default is true.
No description available in the XSD standard.
function getSampleHolder_List
std :: vector < Inscoper :: NBO :: SampleHolderPtr > getSampleHolder_List () const
Returns the list of SampleHolder elements.
Return : The list of SampleHolder elements
No description available in the XSD standard.
function addToSampleHolder_List
void addToSampleHolder_List (
const Inscoper :: NBO :: SampleHolderPtr & value ,
bool validate = true
)
Adds a new SampleHolder 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 clearSampleHolder_List
void clearSampleHolder_List ()
Clear the list of SampleHolder .
No description available in the XSD standard.
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
Inscoper :: NBO :: DescriptionPtr getDescription () const
Returns the value of the Description element.
Return : The value of the element
No description available in the XSD standard.
function resetDescription
Resets the Description element to an unset state.
No description available in the XSD standard.
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_List
void setAnnotationRef_List (
const std :: vector < Inscoper :: NBO :: AnnotationRefPtr > & value ,
bool validate = true
)
Sets the list of AnnotationRef elements.
Parameters :
value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.
This is a simple multi-line comment or annotation describing this component.
function getAnnotationRef_List
std :: vector < Inscoper :: NBO :: AnnotationRefPtr > getAnnotationRef_List () const
Returns the list of AnnotationRef elements.
Return : The list of AnnotationRef elements
This is a simple multi-line comment or annotation describing this component.
function addToAnnotationRef_List
void addToAnnotationRef_List (
const Inscoper :: NBO :: AnnotationRefPtr & value ,
bool validate = true
)
Adds a new AnnotationRef element to this object.
Parameters :
value The element to add
validate If true, validates constraints on value. Default is true.
This is a simple multi-line comment or annotation describing this component.
function clearAnnotationRef_List
void clearAnnotationRef_List ()
Clear the list of AnnotationRef .
This is a simple multi-line comment or annotation describing this component.
function fromBase
static std :: shared_ptr < Sample > fromBase (
NBOBaseClassPtr base
)
Cast a NBOBaseClass to a Sample .
Parameters :
base The base class to cast
Return : The casted element, or nullptr if the cast fails
function getOrganismAllowedValues
static const std :: set < std :: string > & getOrganismAllowedValues ()
Returns the allowed values for this attribut.
Return : The list of allowed values
If this sample is of biological origin, this field records the biological organisn this sample derives from. A biological is a biological entity that consists of one or more cells and is capable of genomic replication (independently or not). The use terms from NCBITaxon (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended. Note: if the sample is not of biological origin please enter none.
function getOrganismTermAccessionAllowedValues
static const std :: set < std :: string > & getOrganismTermAccessionAllowedValues ()
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 Organism. The use of the NCBITaxon ontology (http://purl.obolibrary.org/obo/NCBITaxon_1 ) is recommended.
function getOrganismPartAllowedValues
static const std :: set < std :: string > & getOrganismPartAllowedValues ()
Returns the allowed values for this attribut.
Return : The list of allowed values
If applicable, this field records the part of organism's anatomy or substance arising from an organism from which the biomaterial was derived, excludes cells. E.g. tissue, organ, system, sperm, blood or body location (arm). The use of a sub-class of the 'Organism Part' (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function getOrganismPartTermAccessionAllowedValues
static const std :: set < std :: string > & getOrganismPartTermAccessionAllowedValues ()
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 Organism. A sub-classe of the EFO:0000635 (http://www.ebi.ac.uk/efo/EFO_0000635 ) term from the Experimental Factor Ontology (EFO; http://www.ebi.ac.uk/efo/ ) is recommended.
function getSamplePreparationMethodAllowedValues function getSamplePreparationMethodTermAccessionAllowedValues
static const std :: set < std :: string > & getSamplePreparationMethodTermAccessionAllowedValues ()
Returns the allowed values for this attribut.
Return : The list of allowed values
This field records the the Accession ID for the term used to describe method that was used to prepare this sample. A subclass of the Fbbi:00000001 (http://purl.obolibrary.org/obo/FBbi_00000001 ) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi ) is recommended.
Updated on 2026-10-26 at 15:25:54 +0100