Inscoper::NBO::MicroscopeTable¶

Represents the XML element MicroscopeTable. More...

#include <MicroscopeTable.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	MicroscopeTable()
	~MicroscopeTable()
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::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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	setMultipleMicroscopes(const bool & value, bool validate =true) Sets the value of the MultipleMicroscopes attribute.
bool	getMultipleMicroscopes() const Returns the value of the MultipleMicroscopes attribute.
void	resetMultipleMicroscopes() Resets the MultipleMicroscopes attribute to an unset state.
bool	hasMultipleMicroscopes() const Checks whether the MultipleMicroscopes attribute is present.
void	setType(const Inscoper::NBO::MicroscopeTableType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
MicroscopeTableType_TypePtr	getType() const Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
bool	hasType() const Checks whether the optional Type attribute is present.
void	setTableWidth(const float & value, bool validate =true) Sets the value of the TableWidth attribute.
float	getTableWidth() const Returns the value of the TableWidth attribute.
void	resetTableWidth() Resets the TableWidth attribute to an unset state.
bool	hasTableWidth() const Checks whether the TableWidth attribute is present.
void	setTableWidthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the TableWidthUnit attribute.
UnitsLength_TypePtr	getTableWidthUnit() const Returns the value of the TableWidthUnit attribute.
void	resetTableWidthUnit() Resets the TableWidthUnit attribute to an unset state.
bool	hasTableWidthUnit() const Checks whether the optional TableWidthUnit attribute is present.
void	setTableDepth(const float & value, bool validate =true) Sets the value of the TableDepth attribute.
float	getTableDepth() const Returns the value of the TableDepth attribute.
void	resetTableDepth() Resets the TableDepth attribute to an unset state.
bool	hasTableDepth() const Checks whether the TableDepth attribute is present.
void	setTableDepthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the TableDepthUnit attribute.
UnitsLength_TypePtr	getTableDepthUnit() const Returns the value of the TableDepthUnit attribute.
void	resetTableDepthUnit() Resets the TableDepthUnit attribute to an unset state.
bool	hasTableDepthUnit() const Checks whether the optional TableDepthUnit 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.
std::shared_ptr< MicroscopeTable >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a MicroscopeTable.

Additional inherited members¶

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

Represents the XML element MicroscopeTable.

This element describes the Table used to support this Instrument during Image Acquisition.

Public Functions Documentation¶

function MicroscopeTable¶

function ~MicroscopeTable¶

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

void setID(
    const Inscoper::NBO::LSID_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.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & 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 component.

function getName¶

function resetName¶

function hasName¶

function setMultipleMicroscopes¶

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

Sets the value of the MultipleMicroscopes attribute.

Parameters:

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

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function getMultipleMicroscopes¶

bool getMultipleMicroscopes() const

Returns the value of the MultipleMicroscopes attribute.

Return: The value of the attribute

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function resetMultipleMicroscopes¶

void resetMultipleMicroscopes()

Resets the MultipleMicroscopes attribute to an unset state.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function hasMultipleMicroscopes¶

bool hasMultipleMicroscopes() const

Checks whether the MultipleMicroscopes attribute is present.

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

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function setType¶

void setType(
    const Inscoper::NBO::MicroscopeTableType_TypePtr & value,
    bool validate =true
)

Sets the value of the Type attribute.

Parameters:

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

This field describes the type of this Microscope Table.

function getType¶

function resetType¶

function hasType¶

bool hasType() const

Checks whether the optional Type attribute is present.

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

This field describes the type of this Microscope Table.

function setTableWidth¶

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

Sets the value of the TableWidth attribute.

Parameters:

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

The Width of this Microscope Table.

function getTableWidth¶

function resetTableWidth¶

function hasTableWidth¶

function setTableWidthUnit¶

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

Sets the value of the TableWidthUnit 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 getTableWidthUnit¶

function resetTableWidthUnit¶

function hasTableWidthUnit¶

bool hasTableWidthUnit() const

Checks whether the optional TableWidthUnit attribute is present.

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

No description available in the XSD standard.

function setTableDepth¶

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

Sets the value of the TableDepth attribute.

Parameters:

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

The Depth of this Microscope Table.

function getTableDepth¶

function resetTableDepth¶

function hasTableDepth¶

function setTableDepthUnit¶

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

Sets the value of the TableDepthUnit 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 getTableDepthUnit¶

function resetTableDepthUnit¶

function hasTableDepthUnit¶

bool hasTableDepthUnit() const

Checks whether the optional TableDepthUnit attribute is present.

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

No description available in the XSD standard.

function setAnnotationRef¶

void setAnnotationRef(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Sets the value of the AnnotationRef element.

Parameters:

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

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

Checks whether the optional AnnotationRef element is present.

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

This is a simple multi-line comment or annotation describing this component.

function fromBase¶

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

Cast a NBOBaseClass to a MicroscopeTable.

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