Inscoper::NBO::StageLabel¶

Represents the XML element StageLabel. More...

#include <StageLabel.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	StageLabel()
	~StageLabel()
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	setName(const std::string & value, bool validate =true) Sets the value of the Name attribute.
std::string	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 Name attribute is present.
void	setX(const float & value, bool validate =true) Sets the value of the X attribute.
float	getX() const Returns the value of the X attribute.
void	resetX() Resets the X attribute to an unset state.
bool	hasX() const Checks whether the X attribute is present.
void	setXUnits(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the XUnits attribute.
UnitsLength_TypePtr	getXUnits() const Returns the value of the XUnits attribute.
void	resetXUnits() Resets the XUnits attribute to an unset state.
bool	hasXUnits() const Checks whether the optional XUnits attribute is present.
void	setY(const float & value, bool validate =true) Sets the value of the Y attribute.
float	getY() const Returns the value of the Y attribute.
void	resetY() Resets the Y attribute to an unset state.
bool	hasY() const Checks whether the Y attribute is present.
void	setYUnits(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the YUnits attribute.
UnitsLength_TypePtr	getYUnits() const Returns the value of the YUnits attribute.
void	resetYUnits() Resets the YUnits attribute to an unset state.
bool	hasYUnits() const Checks whether the optional YUnits attribute is present.
void	setZ(const float & value, bool validate =true) Sets the value of the Z attribute.
float	getZ() const Returns the value of the Z attribute.
void	resetZ() Resets the Z attribute to an unset state.
bool	hasZ() const Checks whether the Z attribute is present.
void	setZUnits(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ZUnits attribute.
UnitsLength_TypePtr	getZUnits() const Returns the value of the ZUnits attribute.
void	resetZUnits() Resets the ZUnits attribute to an unset state.
bool	hasZUnits() const Checks whether the optional ZUnits attribute is present.
std::shared_ptr< StageLabel >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a StageLabel.
const std::set< std::string > &	getNameAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::StageLabel;

Represents the XML element StageLabel.

The StageLabel is used to specify the Name and Position for a Stage position in the Microscope's reference frame.

Public Functions Documentation¶

function StageLabel¶

function ~StageLabel¶

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

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

Sets the value of the Name attribute.

Parameters:

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

A User-defined Name for this Stage Label.

function getName¶

function resetName¶

function hasName¶

function setX¶

void setX(
    const float & value,
    bool validate =true
)

Sets the value of the X attribute.

Parameters:

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

The X position of this StageLabel.

function getX¶

function resetX¶

function hasX¶

function setXUnits¶

void setXUnits(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the XUnits attribute.

Parameters:

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

No description available in the XSD standard.

function getXUnits¶

function resetXUnits¶

function hasXUnits¶

function setY¶

void setY(
    const float & value,
    bool validate =true
)

Sets the value of the Y attribute.

Parameters:

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

The Y position of this StageLabel.

function getY¶

function resetY¶

function hasY¶

function setYUnits¶

void setYUnits(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the YUnits attribute.

Parameters:

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

No description available in the XSD standard.

function getYUnits¶

function resetYUnits¶

function hasYUnits¶

function setZ¶

void setZ(
    const float & value,
    bool validate =true
)

Sets the value of the Z attribute.

Parameters:

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

The Z position of this StageLabel.

function getZ¶

function resetZ¶

function hasZ¶

function setZUnits¶

void setZUnits(
    const Inscoper::NBO::UnitsLength_TypePtr & value,
    bool validate =true
)

Sets the value of the ZUnits attribute.

Parameters:

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

No description available in the XSD standard.

function getZUnits¶

function resetZUnits¶

function hasZUnits¶

function fromBase¶

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

Cast a NBOBaseClass to a StageLabel.

Parameters:

base The base class to cast

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

function getNameAllowedValues¶

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

Returns the allowed values for this attribut.

Return: The list of allowed values

A User-defined Name for this Stage Label.

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