Skip to content

Inscoper::NBO::PointDetector_Type

Represents the XML complex type PointDetector. More...

#include <PointDetector_Type.h>

Inherits from Inscoper::NBO::Detector_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::HybridPhotoDetector, Inscoper::NBO::PhotoDiode, Inscoper::NBO::PhotoMultiplierTube

Public Functions

Name
PointDetector_Type()
~PointDetector_Type()
virtual 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 setCoating(const Inscoper::NBO::CoatingMaterial_TypePtr & value, bool validate =true)
Sets the value of the Coating attribute.
CoatingMaterial_TypePtr getCoating() const
Returns the value of the Coating attribute.
void resetCoating()
Resets the Coating attribute to an unset state.
bool hasCoating() const
Checks whether the optional Coating attribute is present.
void setSignalProcessing(const Inscoper::NBO::SignalProcessingMode_TypePtr & value, bool validate =true)
Sets the value of the SignalProcessing attribute.
SignalProcessingMode_TypePtr getSignalProcessing() const
Returns the value of the SignalProcessing attribute.
void resetSignalProcessing()
Resets the SignalProcessing attribute to an unset state.
bool hasSignalProcessing() const
Checks whether the optional SignalProcessing attribute is present.
void setResponseTime(const float & value, bool validate =true)
Sets the value of the ResponseTime attribute.
float getResponseTime() const
Returns the value of the ResponseTime attribute.
void resetResponseTime()
Resets the ResponseTime attribute to an unset state.
bool hasResponseTime() const
Checks whether the ResponseTime attribute is present.
void setResponseTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true)
Sets the value of the ResponseTimeUnit attribute.
UnitsTime_TypePtr getResponseTimeUnit() const
Returns the value of the ResponseTimeUnit attribute.
void resetResponseTimeUnit()
Resets the ResponseTimeUnit attribute to an unset state.
bool hasResponseTimeUnit() const
Checks whether the optional ResponseTimeUnit attribute is present.
void setDeadTime(const float & value, bool validate =true)
Sets the value of the DeadTime attribute.
float getDeadTime() const
Returns the value of the DeadTime attribute.
void resetDeadTime()
Resets the DeadTime attribute to an unset state.
bool hasDeadTime() const
Checks whether the DeadTime attribute is present.
void setDeadTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true)
Sets the value of the DeadTimeUnit attribute.
UnitsTime_TypePtr getDeadTimeUnit() const
Returns the value of the DeadTimeUnit attribute.
void resetDeadTimeUnit()
Resets the DeadTimeUnit attribute to an unset state.
bool hasDeadTimeUnit() const
Checks whether the optional DeadTimeUnit attribute is present.
void setRadiantSensitivity(const float & value, bool validate =true)
Sets the value of the RadiantSensitivity attribute.
float getRadiantSensitivity() const
Returns the value of the RadiantSensitivity attribute.
void resetRadiantSensitivity()
Resets the RadiantSensitivity attribute to an unset state.
bool hasRadiantSensitivity() const
Checks whether the RadiantSensitivity attribute is present.
void setRadiantSensitivityUnit(const Inscoper::NBO::UnitsPower_TypePtr & value, bool validate =true)
Sets the value of the RadiantSensitivityUnit attribute.
UnitsPower_TypePtr getRadiantSensitivityUnit() const
Returns the value of the RadiantSensitivityUnit attribute.
void resetRadiantSensitivityUnit()
Resets the RadiantSensitivityUnit attribute to an unset state.
bool hasRadiantSensitivityUnit() const
Checks whether the optional RadiantSensitivityUnit attribute is present.
std::shared_ptr< PointDetector_Type > fromBase(NBOBaseClassPtr base)
Cast a NBOBaseClass to a PointDetector_Type.

Additional inherited members

Public Classes inherited from Inscoper::NBO::Detector_Type

Name
class InlineWavelengthRange
Represents the XML element WavelengthRange.

Public Types inherited from Inscoper::NBO::Detector_Type

Name
typedef std::shared_ptr< InlineWavelengthRange > InlineWavelengthRangePtr

Public Functions inherited from Inscoper::NBO::Detector_Type

Name
Detector_Type()
~Detector_Type()
void setID(const Inscoper::NBO::DetectorID_TypePtr & value, bool validate =true)
Sets the value of the ID attribute.
DetectorID_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 setMount(const Inscoper::NBO::DetectorMount_TypePtr & value, bool validate =true)
Sets the value of the Mount attribute.
DetectorMount_TypePtr getMount() const
Returns the value of the Mount attribute.
void resetMount()
Resets the Mount attribute to an unset state.
bool hasMount() const
Checks whether the optional Mount attribute is present.
void setMaxBitDepth(const Inscoper::NBO::DigitizerType_TypePtr & value, bool validate =true)
Sets the value of the MaxBitDepth attribute.
DigitizerType_TypePtr getMaxBitDepth() const
Returns the value of the MaxBitDepth attribute.
void resetMaxBitDepth()
Resets the MaxBitDepth attribute to an unset state.
bool hasMaxBitDepth() const
Checks whether the optional MaxBitDepth attribute is present.
void setQuantumEfficiency(const float & value, bool validate =true)
Sets the value of the QuantumEfficiency attribute.
float getQuantumEfficiency() const
Returns the value of the QuantumEfficiency attribute.
void resetQuantumEfficiency()
Resets the QuantumEfficiency attribute to an unset state.
bool hasQuantumEfficiency() const
Checks whether the QuantumEfficiency attribute is present.
void setElectronicConversionFactor(const float & value, bool validate =true)
Sets the value of the ElectronicConversionFactor attribute.
float getElectronicConversionFactor() const
Returns the value of the ElectronicConversionFactor attribute.
void resetElectronicConversionFactor()
Resets the ElectronicConversionFactor attribute to an unset state.
bool hasElectronicConversionFactor() const
Checks whether the ElectronicConversionFactor attribute is present.
void setReadOutNoise(const float & value, bool validate =true)
Sets the value of the ReadOutNoise attribute.
float getReadOutNoise() const
Returns the value of the ReadOutNoise attribute.
void resetReadOutNoise()
Resets the ReadOutNoise attribute to an unset state.
bool hasReadOutNoise() const
Checks whether the ReadOutNoise attribute is present.
void setReadNoiseUnit(const Inscoper::NBO::UnitsElectricCurrent_TypePtr & value, bool validate =true)
Sets the value of the ReadNoiseUnit attribute.
UnitsElectricCurrent_TypePtr getReadNoiseUnit() const
Returns the value of the ReadNoiseUnit attribute.
void resetReadNoiseUnit()
Resets the ReadNoiseUnit attribute to an unset state.
bool hasReadNoiseUnit() const
Checks whether the optional ReadNoiseUnit attribute is present.
void setDetectorNoiseModel(const Inscoper::NBO::DetectorNoiseModel_TypePtr & value, bool validate =true)
Sets the value of the DetectorNoiseModel attribute.
DetectorNoiseModel_TypePtr getDetectorNoiseModel() const
Returns the value of the DetectorNoiseModel attribute.
void resetDetectorNoiseModel()
Resets the DetectorNoiseModel attribute to an unset state.
bool hasDetectorNoiseModel() const
Checks whether the optional DetectorNoiseModel attribute is present.
void setDarkCurrentRate(const float & value, bool validate =true)
Sets the value of the DarkCurrentRate attribute.
float getDarkCurrentRate() const
Returns the value of the DarkCurrentRate attribute.
void resetDarkCurrentRate()
Resets the DarkCurrentRate attribute to an unset state.
bool hasDarkCurrentRate() const
Checks whether the DarkCurrentRate attribute is present.
void setDarkCurrentRateUnit(const Inscoper::NBO::UnitsElectricCurrent_TypePtr & value, bool validate =true)
Sets the value of the DarkCurrentRateUnit attribute.
UnitsElectricCurrent_TypePtr getDarkCurrentRateUnit() const
Returns the value of the DarkCurrentRateUnit attribute.
void resetDarkCurrentRateUnit()
Resets the DarkCurrentRateUnit attribute to an unset state.
bool hasDarkCurrentRateUnit() const
Checks whether the optional DarkCurrentRateUnit attribute is present.
void setDynamicRange(const float & value, bool validate =true)
Sets the value of the DynamicRange attribute.
float getDynamicRange() const
Returns the value of the DynamicRange attribute.
void resetDynamicRange()
Resets the DynamicRange attribute to an unset state.
bool hasDynamicRange() const
Checks whether the DynamicRange attribute is present.
void setDynamicRangeUnit(const Inscoper::NBO::UnitsRatio_TypePtr & value, bool validate =true)
Sets the value of the DynamicRangeUnit attribute.
UnitsRatio_TypePtr getDynamicRangeUnit() const
Returns the value of the DynamicRangeUnit attribute.
void resetDynamicRangeUnit()
Resets the DynamicRangeUnit attribute to an unset state.
bool hasDynamicRangeUnit() const
Checks whether the optional DynamicRangeUnit attribute is present.
void setAmbientOperatingTemperature(const float & value, bool validate =true)
Sets the value of the AmbientOperatingTemperature attribute.
float getAmbientOperatingTemperature() const
Returns the value of the AmbientOperatingTemperature attribute.
void resetAmbientOperatingTemperature()
Resets the AmbientOperatingTemperature attribute to an unset state.
bool hasAmbientOperatingTemperature() const
Checks whether the AmbientOperatingTemperature attribute is present.
void setAmbientOperatingTemperatureUnit(const Inscoper::NBO::UnitsTemperature_TypePtr & value, bool validate =true)
Sets the value of the AmbientOperatingTemperatureUnit attribute.
UnitsTemperature_TypePtr getAmbientOperatingTemperatureUnit() const
Returns the value of the AmbientOperatingTemperatureUnit attribute.
void resetAmbientOperatingTemperatureUnit()
Resets the AmbientOperatingTemperatureUnit attribute to an unset state.
bool hasAmbientOperatingTemperatureUnit() const
Checks whether the optional AmbientOperatingTemperatureUnit attribute is present.
void setAmbientOperatingHumidity(const float & value, bool validate =true)
Sets the value of the AmbientOperatingHumidity attribute.
float getAmbientOperatingHumidity() const
Returns the value of the AmbientOperatingHumidity attribute.
void resetAmbientOperatingHumidity()
Resets the AmbientOperatingHumidity attribute to an unset state.
bool hasAmbientOperatingHumidity() const
Checks whether the AmbientOperatingHumidity attribute is present.
void setRelayLensRef(const Inscoper::NBO::LensRef_TypePtr & value, bool validate =true)
Sets the value of the RelayLensRef element.
Inscoper::NBO::LensRef_TypePtr getRelayLensRef() const
Returns the value of the RelayLensRef element.
void resetRelayLensRef()
Resets the RelayLensRef element to an unset state.
bool hasRelayLensRef() const
Checks whether the optional RelayLensRef 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.
void setWavelengthRange_List(const std::vector< Inscoper::NBO::Detector_Type::InlineWavelengthRangePtr > & value, bool validate =true)
Sets the list of WavelengthRange elements.
std::vector< Inscoper::NBO::Detector_Type::InlineWavelengthRangePtr > getWavelengthRange_List() const
Returns the list of WavelengthRange elements.
void addToWavelengthRange_List(const Inscoper::NBO::Detector_Type::InlineWavelengthRangePtr & value, bool validate =true)
Adds a new WavelengthRange element to this object.
void clearWavelengthRange_List()
Clear the list of WavelengthRange.

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::PointDetector_Type;

Represents the XML complex type PointDetector.

This element represents any Detector that collects light from a restricted point-like area of an Image. These detectors are typically used in Laser Scanning Confocal Microscopy.

Public Functions Documentation

function PointDetector_Type

function ~PointDetector_Type

function getTypeName

function getXMLName

function getNBOType

function getChildren

function getSubElements

function fromJsonFile

function fromJsonString

function fromXmlFile

function fromXmlString

function toXmlFile

function toXmlString

function setCoating

function getCoating

function resetCoating

function hasCoating

function setSignalProcessing

function getSignalProcessing

function resetSignalProcessing

function hasSignalProcessing

function setResponseTime

function getResponseTime

function resetResponseTime

function hasResponseTime

function setResponseTimeUnit

function getResponseTimeUnit

function resetResponseTimeUnit

function hasResponseTimeUnit

function setDeadTime

function getDeadTime

function resetDeadTime

function hasDeadTime

function setDeadTimeUnit

function getDeadTimeUnit

function resetDeadTimeUnit

function hasDeadTimeUnit

function setRadiantSensitivity

function getRadiantSensitivity

function resetRadiantSensitivity

function hasRadiantSensitivity

function setRadiantSensitivityUnit

function getRadiantSensitivityUnit

function resetRadiantSensitivityUnit

function hasRadiantSensitivityUnit

function fromBase