Inscoper::NBO::GenericExcitationSource¶

Represents the XML element GenericExcitationSource. More...

#include <GenericExcitationSource.h>

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

Public Functions¶

	Name
	GenericExcitationSource()
	~GenericExcitationSource()
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	setIlluminationWavelengthRange_List(const std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr > & value, bool validate =true) Sets the list of IlluminationWavelengthRange elements.
std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr >	getIlluminationWavelengthRange_List() const Returns the list of IlluminationWavelengthRange elements.
void	addToIlluminationWavelengthRange_List(const Inscoper::NBO::IlluminationWavelengthRangePtr & value, bool validate =true) Adds a new IlluminationWavelengthRange element to this object.
void	clearIlluminationWavelengthRange_List() Clear the list of IlluminationWavelengthRange.
void	setMap(const Inscoper::NBO::Map_TypePtr & value, bool validate =true) Sets the value of the Map element.
Inscoper::NBO::Map_TypePtr	getMap() const Returns the value of the Map element.
void	resetMap() Resets the Map element to an unset state.
bool	hasMap() const Checks whether the optional Map element is present.
std::shared_ptr< GenericExcitationSource >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a GenericExcitationSource.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::LightSource_Type

	Name
	LightSource_Type()
	~LightSource_Type()
void	setID(const Inscoper::NBO::LightSourceID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LightSourceID_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	setPurchaseDate(const std::string & value, bool validate =true) Sets the value of the PurchaseDate attribute.
std::string	getPurchaseDate() const Returns the value of the PurchaseDate attribute.
void	resetPurchaseDate() Resets the PurchaseDate attribute to an unset state.
bool	hasPurchaseDate() const Checks whether the PurchaseDate attribute is present.
void	setIlluminationPowerReportingStatistic(const Inscoper::NBO::LightSourceIlluminationPowerReportingStatistic_TypePtr & value, bool validate =true) Sets the value of the IlluminationPowerReportingStatistic attribute.
LightSourceIlluminationPowerReportingStatistic_TypePtr	getIlluminationPowerReportingStatistic() const Returns the value of the IlluminationPowerReportingStatistic attribute.
void	resetIlluminationPowerReportingStatistic() Resets the IlluminationPowerReportingStatistic attribute to an unset state.
bool	hasIlluminationPowerReportingStatistic() const Checks whether the optional IlluminationPowerReportingStatistic attribute is present.
void	setIlluminationPowerReportingPosition(const Inscoper::NBO::LightSourceIlluminationPowerReportingPosition_TypePtr & value, bool validate =true) Sets the value of the IlluminationPowerReportingPosition attribute.
LightSourceIlluminationPowerReportingPosition_TypePtr	getIlluminationPowerReportingPosition() const Returns the value of the IlluminationPowerReportingPosition attribute.
void	resetIlluminationPowerReportingPosition() Resets the IlluminationPowerReportingPosition attribute to an unset state.
bool	hasIlluminationPowerReportingPosition() const Checks whether the optional IlluminationPowerReportingPosition attribute 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.
const std::set< std::string > &	getPurchaseDateAllowedValues() Returns the allowed values for this attribut.

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

Represents the XML element GenericExcitationSource.

The GenericExcitationSource element is used to represent a light source as a collection of key/value pairs, stored in a Map. One of the other light source elements should always be used in preference to this if possible.

Public Functions Documentation¶

function GenericExcitationSource¶

function ~GenericExcitationSource¶

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

void setIlluminationWavelengthRange_List(
    const std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr > & value,
    bool validate =true
)

Sets the list of IlluminationWavelengthRange elements.

Parameters:

value The new list of IlluminationWavelengthRange elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getIlluminationWavelengthRange_List¶

std::vector< Inscoper::NBO::IlluminationWavelengthRangePtr > getIlluminationWavelengthRange_List() const

Returns the list of IlluminationWavelengthRange elements.

Return: The list of IlluminationWavelengthRange elements

No description available in the XSD standard.

function addToIlluminationWavelengthRange_List¶

void addToIlluminationWavelengthRange_List(
    const Inscoper::NBO::IlluminationWavelengthRangePtr & value,
    bool validate =true
)

Adds a new IlluminationWavelengthRange 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 clearIlluminationWavelengthRange_List¶

function setMap¶

void setMap(
    const Inscoper::NBO::Map_TypePtr & value,
    bool validate =true
)

Sets the value of the Map element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is a Mapping of key/value pairs used to store customized metadata that describes this element.

function getMap¶

Inscoper::NBO::Map_TypePtr getMap() const

Returns the value of the Map element.

Return: The value of the element

This is a Mapping of key/value pairs used to store customized metadata that describes this element.

function resetMap¶

function hasMap¶

bool hasMap() const

Checks whether the optional Map element is present.

Return: true if the optional attribute has been set, false otherwise

This is a Mapping of key/value pairs used to store customized metadata that describes this element.

function fromBase¶

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

Cast a NBOBaseClass to a GenericExcitationSource.

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:38 +0200