Inscoper::NBO::AnalogVideo¶

Represents the XML element AnalogVideo. More...

#include <AnalogVideo.h>

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

Public Functions¶

	Name
	AnalogVideo()
	~AnalogVideo()
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.
std::shared_ptr< AnalogVideo >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a AnalogVideo.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Camera_Type

	Name
	Camera_Type()
	~Camera_Type()
void	setArrayWidth(const long long & value, bool validate =true) Sets the value of the ArrayWidth attribute.
long long	getArrayWidth() const Returns the value of the ArrayWidth attribute.
void	resetArrayWidth() Resets the ArrayWidth attribute to an unset state.
bool	hasArrayWidth() const Checks whether the ArrayWidth attribute is present.
void	setArrayHeight(const long long & value, bool validate =true) Sets the value of the ArrayHeight attribute.
long long	getArrayHeight() const Returns the value of the ArrayHeight attribute.
void	resetArrayHeight() Resets the ArrayHeight attribute to an unset state.
bool	hasArrayHeight() const Checks whether the ArrayHeight attribute is present.
void	setPixelWidth(const float & value, bool validate =true) Sets the value of the PixelWidth attribute.
float	getPixelWidth() const Returns the value of the PixelWidth attribute.
void	resetPixelWidth() Resets the PixelWidth attribute to an unset state.
bool	hasPixelWidth() const Checks whether the PixelWidth attribute is present.
void	setPixelWidthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PixelWidthUnit attribute.
UnitsLength_TypePtr	getPixelWidthUnit() const Returns the value of the PixelWidthUnit attribute.
void	resetPixelWidthUnit() Resets the PixelWidthUnit attribute to an unset state.
bool	hasPixelWidthUnit() const Checks whether the optional PixelWidthUnit attribute is present.
void	setPixelHeight(const float & value, bool validate =true) Sets the value of the PixelHeight attribute.
float	getPixelHeight() const Returns the value of the PixelHeight attribute.
void	resetPixelHeight() Resets the PixelHeight attribute to an unset state.
bool	hasPixelHeight() const Checks whether the PixelHeight attribute is present.
void	setPixelHeightUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the PixelHeightUnit attribute.
UnitsLength_TypePtr	getPixelHeightUnit() const Returns the value of the PixelHeightUnit attribute.
void	resetPixelHeightUnit() Resets the PixelHeightUnit attribute to an unset state.
bool	hasPixelHeightUnit() const Checks whether the optional PixelHeightUnit attribute is present.
void	setIllumination(const Inscoper::NBO::CameraIllumination_TypePtr & value, bool validate =true) Sets the value of the Illumination attribute.
CameraIllumination_TypePtr	getIllumination() const Returns the value of the Illumination attribute.
void	resetIllumination() Resets the Illumination attribute to an unset state.
bool	hasIllumination() const Checks whether the optional Illumination attribute is present.
void	setManufacturerOffet(const float & value, bool validate =true) Sets the value of the ManufacturerOffet attribute.
float	getManufacturerOffet() const Returns the value of the ManufacturerOffet attribute.
void	resetManufacturerOffet() Resets the ManufacturerOffet attribute to an unset state.
bool	hasManufacturerOffet() const Checks whether the ManufacturerOffet attribute is present.
void	setColor(const Inscoper::NBO::ColorMode_TypePtr & value, bool validate =true) Sets the value of the Color attribute.
ColorMode_TypePtr	getColor() const Returns the value of the Color attribute.
void	resetColor() Resets the Color attribute to an unset state.
bool	hasColor() const Checks whether the optional Color attribute is present.
void	setPixelWellCapacity(const long long & value, bool validate =true) Sets the value of the PixelWellCapacity attribute.
long long	getPixelWellCapacity() const Returns the value of the PixelWellCapacity attribute.
void	resetPixelWellCapacity() Resets the PixelWellCapacity attribute to an unset state.
bool	hasPixelWellCapacity() const Checks whether the PixelWellCapacity attribute is present.
void	setPixelWellCapacityUnit(const Inscoper::NBO::UnitsElectricCharge_TypePtr & value, bool validate =true) Sets the value of the PixelWellCapacityUnit attribute.
UnitsElectricCharge_TypePtr	getPixelWellCapacityUnit() const Returns the value of the PixelWellCapacityUnit attribute.
void	resetPixelWellCapacityUnit() Resets the PixelWellCapacityUnit attribute to an unset state.
bool	hasPixelWellCapacityUnit() const Checks whether the optional PixelWellCapacityUnit attribute is present.
void	setMaximumFrameRate(const float & value, bool validate =true) Sets the value of the MaximumFrameRate attribute.
float	getMaximumFrameRate() const Returns the value of the MaximumFrameRate attribute.
void	resetMaximumFrameRate() Resets the MaximumFrameRate attribute to an unset state.
bool	hasMaximumFrameRate() const Checks whether the MaximumFrameRate attribute is present.
void	setMaximumFrameRateUnit(const Inscoper::NBO::UnitsFrequency_TypePtr & value, bool validate =true) Sets the value of the MaximumFrameRateUnit attribute.
UnitsFrequency_TypePtr	getMaximumFrameRateUnit() const Returns the value of the MaximumFrameRateUnit attribute.
void	resetMaximumFrameRateUnit() Resets the MaximumFrameRateUnit attribute to an unset state.
bool	hasMaximumFrameRateUnit() const Checks whether the optional MaximumFrameRateUnit attribute is present.
void	setMaximumReadoutRate(const float & value, bool validate =true) Sets the value of the MaximumReadoutRate attribute.
float	getMaximumReadoutRate() const Returns the value of the MaximumReadoutRate attribute.
void	resetMaximumReadoutRate() Resets the MaximumReadoutRate attribute to an unset state.
bool	hasMaximumReadoutRate() const Checks whether the MaximumReadoutRate attribute is present.
void	setMaximumReadoutRateUnit(const Inscoper::NBO::UnitsFrequency_TypePtr & value, bool validate =true) Sets the value of the MaximumReadoutRateUnit attribute.
UnitsFrequency_TypePtr	getMaximumReadoutRateUnit() const Returns the value of the MaximumReadoutRateUnit attribute.
void	resetMaximumReadoutRateUnit() Resets the MaximumReadoutRateUnit attribute to an unset state.
bool	hasMaximumReadoutRateUnit() const Checks whether the optional MaximumReadoutRateUnit attribute is present.
void	setVerticalClockSpeed(const float & value, bool validate =true) Sets the value of the VerticalClockSpeed attribute.
float	getVerticalClockSpeed() const Returns the value of the VerticalClockSpeed attribute.
void	resetVerticalClockSpeed() Resets the VerticalClockSpeed attribute to an unset state.
bool	hasVerticalClockSpeed() const Checks whether the VerticalClockSpeed attribute is present.
void	setVerticalClockSpeedUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the VerticalClockSpeedUnit attribute.
UnitsTime_TypePtr	getVerticalClockSpeedUnit() const Returns the value of the VerticalClockSpeedUnit attribute.
void	resetVerticalClockSpeedUnit() Resets the VerticalClockSpeedUnit attribute to an unset state.
bool	hasVerticalClockSpeedUnit() const Checks whether the optional VerticalClockSpeedUnit attribute is present.

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

Represents the XML element AnalogVideo.

This element represents a device used to capture Analog Videos.

Public Functions Documentation¶

function AnalogVideo¶

function ~AnalogVideo¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

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 fromBase¶

static std::shared_ptr< AnalogVideo > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a AnalogVideo.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Updated on 2026-09-23 at 16:50:36 +0200