Skip to content

Inscoper::NBO::IntensityCalibrationTool

Represents the XML element IntensityCalibrationTool. More...

#include <IntensityCalibrationTool.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions

Name
IntensityCalibrationTool()
~IntensityCalibrationTool()
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 setType(const std::string & value, bool validate =true)
Sets the value of the Type attribute.
std::string getType() const
Returns the value of the Type attribute.
void resetType()
Resets the Type attribute to an unset state.
bool hasType() const
Checks whether the Type attribute is present.
void setCalibrationType(const Inscoper::NBO::IntensityCalibrationType_TypePtr & value, bool validate =true)
Sets the value of the CalibrationType attribute.
IntensityCalibrationType_TypePtr getCalibrationType() const
Returns the value of the CalibrationType attribute.
void resetCalibrationType()
Resets the CalibrationType attribute to an unset state.
bool hasCalibrationType() const
Checks whether the optional CalibrationType attribute is present.
void setLastCalibrationDate(const std::string & value, bool validate =true)
Sets the value of the LastCalibrationDate attribute.
std::string getLastCalibrationDate() const
Returns the value of the LastCalibrationDate attribute.
void resetLastCalibrationDate()
Resets the LastCalibrationDate attribute to an unset state.
bool hasLastCalibrationDate() const
Checks whether the LastCalibrationDate attribute is present.
void setLightSensorRef(const Inscoper::NBO::LightSensorRefPtr & value, bool validate =true)
Sets the value of the LightSensorRef element.
Inscoper::NBO::LightSensorRefPtr getLightSensorRef() const
Returns the value of the LightSensorRef element.
void resetLightSensorRef()
Resets the LightSensorRef element to an unset state.
bool hasLightSensorRef() const
Checks whether the optional LightSensorRef 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< IntensityCalibrationTool > fromBase(NBOBaseClassPtr base)
Cast a NBOBaseClass to a IntensityCalibrationTool.
const std::set< std::string > & getTypeAllowedValues()
Returns the allowed values for this attribut.
const std::set< std::string > & getLastCalibrationDateAllowedValues()
Returns the allowed values for this attribut.

Additional inherited members

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

Name
ManufacturerSpec_Type()
~ManufacturerSpec_Type()
void setManufacturer(const std::string & value, bool validate =true)
Sets the value of the Manufacturer attribute.
std::string getManufacturer() const
Returns the value of the Manufacturer attribute.
void resetManufacturer()
Resets the Manufacturer attribute to an unset state.
bool hasManufacturer() const
Checks whether the Manufacturer attribute is present.
void setModel(const std::string & value, bool validate =true)
Sets the value of the Model attribute.
std::string getModel() const
Returns the value of the Model attribute.
void resetModel()
Resets the Model attribute to an unset state.
bool hasModel() const
Checks whether the Model attribute is present.
void setCatalogNumber(const std::string & value, bool validate =true)
Sets the value of the CatalogNumber attribute.
std::string getCatalogNumber() const
Returns the value of the CatalogNumber attribute.
void resetCatalogNumber()
Resets the CatalogNumber attribute to an unset state.
bool hasCatalogNumber() const
Checks whether the CatalogNumber attribute is present.
void setLotNumber(const std::string & value, bool validate =true)
Sets the value of the LotNumber attribute.
std::string getLotNumber() const
Returns the value of the LotNumber attribute.
void resetLotNumber()
Resets the LotNumber attribute to an unset state.
bool hasLotNumber() const
Checks whether the LotNumber attribute is present.
void setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true)
Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr > getMapAnnotation_List() const
Returns the list of MapAnnotation elements.
void addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true)
Adds a new MapAnnotation element to this object.
void clearMapAnnotation_List()
Clear the list of MapAnnotation.
void setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true)
Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr getSpecsFile() const
Returns the value of the SpecsFile element.
void resetSpecsFile()
Resets the SpecsFile element to an unset state.
bool hasSpecsFile() const
Checks whether the optional SpecsFile element is present.
void setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true)
Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > getAdditionalVendorInformation_List() const
Returns the list of AdditionalVendorInformation elements.
void addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true)
Adds a new AdditionalVendorInformation element to this object.
void clearAdditionalVendorInformation_List()
Clear the list of AdditionalVendorInformation.
const std::set< std::string > & getManufacturerAllowedValues()
Returns the allowed values for this attribut.
const std::set< std::string > & getModelAllowedValues()
Returns the allowed values for this attribut.
const std::set< std::string > & getCatalogNumberAllowedValues()
Returns the allowed values for this attribut.
const std::set< std::string > & getLotNumberAllowedValues()
Returns the allowed values for this attribut.

Detailed Description

class Inscoper::NBO::IntensityCalibrationTool;

Represents the XML element IntensityCalibrationTool.

A tool, such as the Meta-Max calibration toold developed by the 4D Nucleome Imaging Standards Working Group, used to perform an intensity calibration procedure.

Public Functions Documentation

function IntensityCalibrationTool

function ~IntensityCalibrationTool

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 setType

function getType

function resetType

function hasType

function setCalibrationType

function getCalibrationType

function resetCalibrationType

function hasCalibrationType

function setLastCalibrationDate

function getLastCalibrationDate

function resetLastCalibrationDate

function hasLastCalibrationDate

function setLightSensorRef

function getLightSensorRef

function resetLightSensorRef

function hasLightSensorRef

function setAnnotationRef

function getAnnotationRef

function resetAnnotationRef

function hasAnnotationRef

function fromBase

function getTypeAllowedValues

function getLastCalibrationDateAllowedValues