Inscoper::NBO::OpticalApertureSettings_Type¶

Represents the XML complex type OpticalApertureSettings. More...

#include <OpticalApertureSettings_Type.h>

Inherits from Inscoper::NBO::Settings_Type, Inscoper::NBO::Reference_Type, NBOBaseClass

Inherited by Inscoper::NBO::DiffractionGratingSettings, Inscoper::NBO::GenericOpticalApertureSettings, Inscoper::NBO::MaskingPlateSettings, Inscoper::NBO::PinholeSettings

Public Functions¶

	Name
	OpticalApertureSettings_Type()
	~OpticalApertureSettings_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	setID(const Inscoper::NBO::OpticalApertureID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
OpticalApertureID_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	setTransmittanceProfileFile_List(const std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > & value, bool validate =true) Sets the list of TransmittanceProfileFile elements.
std::vector< Inscoper::NBO::TransmittanceProfileFilePtr >	getTransmittanceProfileFile_List() const Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(const Inscoper::NBO::TransmittanceProfileFilePtr & value, bool validate =true) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setReflectanceProfileFile_List(const std::vector< Inscoper::NBO::ReflectanceProfileFilePtr > & value, bool validate =true) Sets the list of ReflectanceProfileFile elements.
std::vector< Inscoper::NBO::ReflectanceProfileFilePtr >	getReflectanceProfileFile_List() const Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(const Inscoper::NBO::ReflectanceProfileFilePtr & value, bool validate =true) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
void	setTransmissionWavelengthRangeSettings_List(const std::vector< Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr > & value, bool validate =true) Sets the list of TransmissionWavelengthRangeSettings elements.
std::vector< Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr >	getTransmissionWavelengthRangeSettings_List() const Returns the list of TransmissionWavelengthRangeSettings elements.
void	addToTransmissionWavelengthRangeSettings_List(const Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr & value, bool validate =true) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	clearTransmissionWavelengthRangeSettings_List() Clear the list of TransmissionWavelengthRangeSettings.
void	setReflectionWavelengthRangeSettings_List(const std::vector< Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr > & value, bool validate =true) Sets the list of ReflectionWavelengthRangeSettings elements.
std::vector< Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr >	getReflectionWavelengthRangeSettings_List() const Returns the list of ReflectionWavelengthRangeSettings elements.
void	addToReflectionWavelengthRangeSettings_List(const Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr & value, bool validate =true) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	clearReflectionWavelengthRangeSettings_List() Clear the list of ReflectionWavelengthRangeSettings.
std::shared_ptr< OpticalApertureSettings_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a OpticalApertureSettings_Type.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Settings_Type

	Name
	Settings_Type()
	~Settings_Type()
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	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.

Public Functions inherited from Inscoper::NBO::Reference_Type

	Name
	Reference_Type()
	~Reference_Type()

Detailed Description¶

class Inscoper::NBO::OpticalApertureSettings_Type;

Represents the XML complex type OpticalApertureSettings.

This element refers to the Optical Aperture device used to acquire this image and it holds the settings that were applied to it during this Acquisition.

Public Functions Documentation¶

function OpticalApertureSettings_Type¶

function ~OpticalApertureSettings_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

Reimplemented by: Inscoper::NBO::DiffractionGratingSettings::getTypeName, Inscoper::NBO::GenericOpticalApertureSettings::getTypeName, Inscoper::NBO::MaskingPlateSettings::getTypeName, Inscoper::NBO::PinholeSettings::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 setID¶

void setID(
    const Inscoper::NBO::OpticalApertureID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

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

This is the Unique Identifier of the device used in this case.

function getID¶

function resetID¶

function hasID¶

bool hasID() const

Checks whether the optional ID attribute is present.

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

This is the Unique Identifier of the device used in this case.

function setTransmittanceProfileFile_List¶

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

Sets the list of TransmittanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function getTransmittanceProfileFile_List¶

std::vector< Inscoper::NBO::TransmittanceProfileFilePtr > getTransmittanceProfileFile_List() const

Returns the list of TransmittanceProfileFile elements.

Return: The list of TransmittanceProfileFile elements

No description available in the XSD standard.

function addToTransmittanceProfileFile_List¶

void addToTransmittanceProfileFile_List(
    const Inscoper::NBO::TransmittanceProfileFilePtr & value,
    bool validate =true
)

Adds a new TransmittanceProfileFile 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 clearTransmittanceProfileFile_List¶

function setReflectanceProfileFile_List¶

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

Sets the list of ReflectanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function getReflectanceProfileFile_List¶

std::vector< Inscoper::NBO::ReflectanceProfileFilePtr > getReflectanceProfileFile_List() const

Returns the list of ReflectanceProfileFile elements.

Return: The list of ReflectanceProfileFile elements

No description available in the XSD standard.

function addToReflectanceProfileFile_List¶

void addToReflectanceProfileFile_List(
    const Inscoper::NBO::ReflectanceProfileFilePtr & value,
    bool validate =true
)

Adds a new ReflectanceProfileFile 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 clearReflectanceProfileFile_List¶

function setTransmissionWavelengthRangeSettings_List¶

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

Sets the list of TransmissionWavelengthRangeSettings elements.

Parameters:

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

No description available in the XSD standard.

function getTransmissionWavelengthRangeSettings_List¶

std::vector< Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr > getTransmissionWavelengthRangeSettings_List() const

Returns the list of TransmissionWavelengthRangeSettings elements.

Return: The list of TransmissionWavelengthRangeSettings elements

No description available in the XSD standard.

function addToTransmissionWavelengthRangeSettings_List¶

void addToTransmissionWavelengthRangeSettings_List(
    const Inscoper::NBO::TransmissionWavelengthRangeSettingsPtr & value,
    bool validate =true
)

Adds a new TransmissionWavelengthRangeSettings 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 clearTransmissionWavelengthRangeSettings_List¶

function setReflectionWavelengthRangeSettings_List¶

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

Sets the list of ReflectionWavelengthRangeSettings elements.

Parameters:

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

No description available in the XSD standard.

function getReflectionWavelengthRangeSettings_List¶

std::vector< Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr > getReflectionWavelengthRangeSettings_List() const

Returns the list of ReflectionWavelengthRangeSettings elements.

Return: The list of ReflectionWavelengthRangeSettings elements

No description available in the XSD standard.

function addToReflectionWavelengthRangeSettings_List¶

void addToReflectionWavelengthRangeSettings_List(
    const Inscoper::NBO::ReflectionWavelengthRangeSettingsPtr & value,
    bool validate =true
)

Adds a new ReflectionWavelengthRangeSettings 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 clearReflectionWavelengthRangeSettings_List¶

function fromBase¶

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

Cast a NBOBaseClass to a OpticalApertureSettings_Type.

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