Inscoper::NBO::LightSensorRef¶

Represents the XML element LightSensorRef. More...

#include <LightSensorRef.h>

Inherits from Inscoper::NBO::Reference_Type, NBOBaseClass

Public Functions¶

	Name
	LightSensorRef()
	~LightSensorRef()
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	setLightSensorID(const Inscoper::NBO::LightSensorID_TypePtr & value, bool validate =true) Sets the value of the LightSensorID attribute.
LightSensorID_TypePtr	getLightSensorID() const Returns the value of the LightSensorID attribute.
void	resetLightSensorID() Resets the LightSensorID attribute to an unset state.
bool	hasLightSensorID() const Checks whether the optional LightSensorID attribute is present.
std::shared_ptr< LightSensorRef >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a LightSensorRef.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Reference_Type

	Name
	Reference_Type()
	~Reference_Type()

Detailed Description¶

class Inscoper::NBO::LightSensorRef;

Represents the XML element LightSensorRef.

This is an empty element that refers to the Light Sensor associated with this Intensity Calibration Tool.

Public Functions Documentation¶

function LightSensorRef¶

function ~LightSensorRef¶

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

void setLightSensorID(
    const Inscoper::NBO::LightSensorID_TypePtr & value,
    bool validate =true
)

Sets the value of the LightSensorID attribute.

Parameters:

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

A Unique Identifier for this component

function getLightSensorID¶

function resetLightSensorID¶

function hasLightSensorID¶

bool hasLightSensorID() const

Checks whether the optional LightSensorID attribute is present.

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

A Unique Identifier for this component

function fromBase¶

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

Cast a NBOBaseClass to a LightSensorRef.

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