Skip to content

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

function getXMLName

function getNBOType

function getChildren

function getSubElements

function fromJsonFile

function fromJsonString

function fromXmlFile

function fromXmlString

function toXmlFile

function toXmlString

function setID

function getID

function resetID

function hasID

function setName

function getName

function resetName

function hasName

function setBiologicalOrigin

function getBiologicalOrigin

function resetBiologicalOrigin

function hasBiologicalOrigin

function setSampleType

function getSampleType

function resetSampleType

function hasSampleType

function setLiveSample

function getLiveSample

function resetLiveSample

function hasLiveSample

function setOrganism

function getOrganism

function resetOrganism

function hasOrganism

function setOrganismTermAccession

function getOrganismTermAccession

function resetOrganismTermAccession

function hasOrganismTermAccession

function setOrganismPart

function getOrganismPart

function resetOrganismPart

function hasOrganismPart

function setOrganismPartTermAccession

function getOrganismPartTermAccession

function resetOrganismPartTermAccession

function hasOrganismPartTermAccession

function setSamplePreparationMethod

function getSamplePreparationMethod

function resetSamplePreparationMethod

function hasSamplePreparationMethod

function setSamplePreparationMethodTermAccession

function getSamplePreparationMethodTermAccession

function resetSamplePreparationMethodTermAccession

function hasSamplePreparationMethodTermAccession

function setMetrologySample

function getMetrologySample

function resetMetrologySample

function hasMetrologySample

function setFacingTheObjective

function getFacingTheObjective

function resetFacingTheObjective

function hasFacingTheObjective

function setMountingMedium_List

function getMountingMedium_List

function addToMountingMedium_List

function clearMountingMedium_List

function setCoverGlass_List

function getCoverGlass_List

function addToCoverGlass_List

function clearCoverGlass_List

function setSampleHolder_List

function getSampleHolder_List

function addToSampleHolder_List

function clearSampleHolder_List

function setDescription

function getDescription

function resetDescription

function hasDescription

function setAnnotationRef_List

function getAnnotationRef_List

function addToAnnotationRef_List

function clearAnnotationRef_List

function fromBase

function getOrganismAllowedValues

function getOrganismTermAccessionAllowedValues

function getOrganismPartAllowedValues

function getOrganismPartTermAccessionAllowedValues

function getSamplePreparationMethodAllowedValues

function getSamplePreparationMethodTermAccessionAllowedValues