Inscoper::NBO::FreeBeam¶

Represents the XML element FreeBeam. More...

#include <FreeBeam.h>

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

Public Functions¶

	Name
	FreeBeam()
	~FreeBeam()
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	setDirectMount(const bool & value, bool validate =true) Sets the value of the DirectMount attribute.
bool	getDirectMount() const Returns the value of the DirectMount attribute.
void	resetDirectMount() Resets the DirectMount attribute to an unset state.
bool	hasDirectMount() const Checks whether the DirectMount attribute is present.
void	setMountType(const std::string & value, bool validate =true) Sets the value of the MountType attribute.
std::string	getMountType() const Returns the value of the MountType attribute.
void	resetMountType() Resets the MountType attribute to an unset state.
bool	hasMountType() const Checks whether the MountType attribute is present.
std::shared_ptr< FreeBeam >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a FreeBeam.
const std::set< std::string > &	getMountTypeAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Classes inherited from Inscoper::NBO::LightSourceCoupling_Type

	Name
class	InlineAnnotationRef Represents the XML element AnnotationRef.

Public Types inherited from Inscoper::NBO::LightSourceCoupling_Type

	Name
typedef std::shared_ptr< InlineAnnotationRef >	InlineAnnotationRefPtr

Public Functions inherited from Inscoper::NBO::LightSourceCoupling_Type

	Name
	LightSourceCoupling_Type()
	~LightSourceCoupling_Type()
void	setID(const Inscoper::NBO::LightSourceCouplingID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LightSourceCouplingID_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	setAttenuation(const float & value, bool validate =true) Sets the value of the Attenuation attribute.
float	getAttenuation() const Returns the value of the Attenuation attribute.
void	resetAttenuation() Resets the Attenuation attribute to an unset state.
bool	hasAttenuation() const Checks whether the Attenuation attribute is present.
void	setTransmittance(const float & value, bool validate =true) Sets the value of the Transmittance attribute.
float	getTransmittance() const Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
bool	hasTransmittance() const Checks whether the Transmittance attribute is present.
void	setCouplingLensRef(const Inscoper::NBO::LensRef_TypePtr & value, bool validate =true) Sets the value of the CouplingLensRef element.
Inscoper::NBO::LensRef_TypePtr	getCouplingLensRef() const Returns the value of the CouplingLensRef element.
void	resetCouplingLensRef() Resets the CouplingLensRef element to an unset state.
bool	hasCouplingLensRef() const Checks whether the optional CouplingLensRef element is present.
void	setAnnotationRef(const Inscoper::NBO::LightSourceCoupling_Type::InlineAnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::LightSourceCoupling_Type::InlineAnnotationRefPtr	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.

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

Represents the XML element FreeBeam.

A Free Beam coupling between the Light Source and the Microscope Stand consists of either a direct mount or an optical path that directs light across free space to the back of the Microscope Stand.

Public Functions Documentation¶

function FreeBeam¶

function ~FreeBeam¶

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

void setDirectMount(
    const bool & value,
    bool validate =true
)

Sets the value of the DirectMount attribute.

Parameters:

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

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function getDirectMount¶

bool getDirectMount() const

Returns the value of the DirectMount attribute.

Return: The value of the attribute

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function resetDirectMount¶

void resetDirectMount()

Resets the DirectMount attribute to an unset state.

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function hasDirectMount¶

bool hasDirectMount() const

Checks whether the DirectMount attribute is present.

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

Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).

function setMountType¶

void setMountType(
    const std::string & value,
    bool validate =true
)

Sets the value of the MountType attribute.

Parameters:

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

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function getMountType¶

std::string getMountType() const

Returns the value of the MountType attribute.

Return: The value of the attribute

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function resetMountType¶

void resetMountType()

Resets the MountType attribute to an unset state.

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function hasMountType¶

bool hasMountType() const

Checks whether the MountType attribute is present.

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

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

function fromBase¶

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

Cast a NBOBaseClass to a FreeBeam.

Parameters:

base The base class to cast

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

function getMountTypeAllowedValues¶

static const std::set< std::string > & getMountTypeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.

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