Inscoper::NBO::PiezoElectricStage¶

Represents the XML element PiezoElectricStage. More...

#include <PiezoElectricStage.h>

Inherits from Inscoper::NBO::Stage_Type, Inscoper::NBO::SamplePositioning_Type, Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Public Functions¶

	Name
	PiezoElectricStage()
	~PiezoElectricStage()
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.
std::shared_ptr< PiezoElectricStage >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a PiezoElectricStage.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Stage_Type

	Name
	Stage_Type()
	~Stage_Type()
void	setXYMaxVelocity(const float & value, bool validate =true) Sets the value of the XYMaxVelocity attribute.
float	getXYMaxVelocity() const Returns the value of the XYMaxVelocity attribute.
void	resetXYMaxVelocity() Resets the XYMaxVelocity attribute to an unset state.
bool	hasXYMaxVelocity() const Checks whether the XYMaxVelocity attribute is present.
void	setXYMaxVelocityUnit(const Inscoper::NBO::UnitsVelocity_TypePtr & value, bool validate =true) Sets the value of the XYMaxVelocityUnit attribute.
UnitsVelocity_TypePtr	getXYMaxVelocityUnit() const Returns the value of the XYMaxVelocityUnit attribute.
void	resetXYMaxVelocityUnit() Resets the XYMaxVelocityUnit attribute to an unset state.
bool	hasXYMaxVelocityUnit() const Checks whether the optional XYMaxVelocityUnit attribute is present.
void	setXYRepeatability(const float & value, bool validate =true) Sets the value of the XYRepeatability attribute.
float	getXYRepeatability() const Returns the value of the XYRepeatability attribute.
void	resetXYRepeatability() Resets the XYRepeatability attribute to an unset state.
bool	hasXYRepeatability() const Checks whether the XYRepeatability attribute is present.
void	setXYRepeatabilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the XYRepeatabilityUnit attribute.
UnitsLength_TypePtr	getXYRepeatabilityUnit() const Returns the value of the XYRepeatabilityUnit attribute.
void	resetXYRepeatabilityUnit() Resets the XYRepeatabilityUnit attribute to an unset state.
bool	hasXYRepeatabilityUnit() const Checks whether the optional XYRepeatabilityUnit attribute is present.
void	setXTravelRange(const float & value, bool validate =true) Sets the value of the XTravelRange attribute.
float	getXTravelRange() const Returns the value of the XTravelRange attribute.
void	resetXTravelRange() Resets the XTravelRange attribute to an unset state.
bool	hasXTravelRange() const Checks whether the XTravelRange attribute is present.
void	setXTravelRangeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the XTravelRangeUnit attribute.
UnitsLength_TypePtr	getXTravelRangeUnit() const Returns the value of the XTravelRangeUnit attribute.
void	resetXTravelRangeUnit() Resets the XTravelRangeUnit attribute to an unset state.
bool	hasXTravelRangeUnit() const Checks whether the optional XTravelRangeUnit attribute is present.
void	setYTravelRange(const float & value, bool validate =true) Sets the value of the YTravelRange attribute.
float	getYTravelRange() const Returns the value of the YTravelRange attribute.
void	resetYTravelRange() Resets the YTravelRange attribute to an unset state.
bool	hasYTravelRange() const Checks whether the YTravelRange attribute is present.
void	setYTravelRangeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the YTravelRangeUnit attribute.
UnitsLength_TypePtr	getYTravelRangeUnit() const Returns the value of the YTravelRangeUnit attribute.
void	resetYTravelRangeUnit() Resets the YTravelRangeUnit attribute to an unset state.
bool	hasYTravelRangeUnit() const Checks whether the optional YTravelRangeUnit attribute is present.
void	setXYReproducibility(const float & value, bool validate =true) Sets the value of the XYReproducibility attribute.
float	getXYReproducibility() const Returns the value of the XYReproducibility attribute.
void	resetXYReproducibility() Resets the XYReproducibility attribute to an unset state.
bool	hasXYReproducibility() const Checks whether the XYReproducibility attribute is present.
void	setXYReproducibilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the XYReproducibilityUnit attribute.
UnitsLength_TypePtr	getXYReproducibilityUnit() const Returns the value of the XYReproducibilityUnit attribute.
void	resetXYReproducibilityUnit() Resets the XYReproducibilityUnit attribute to an unset state.
bool	hasXYReproducibilityUnit() const Checks whether the optional XYReproducibilityUnit attribute is present.
void	setXYSettlingTime(const float & value, bool validate =true) Sets the value of the XYSettlingTime attribute.
float	getXYSettlingTime() const Returns the value of the XYSettlingTime attribute.
void	resetXYSettlingTime() Resets the XYSettlingTime attribute to an unset state.
bool	hasXYSettlingTime() const Checks whether the XYSettlingTime attribute is present.
void	setXYSettlingTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the XYSettlingTimeUnit attribute.
UnitsTime_TypePtr	getXYSettlingTimeUnit() const Returns the value of the XYSettlingTimeUnit attribute.
void	resetXYSettlingTimeUnit() Resets the XYSettlingTimeUnit attribute to an unset state.
bool	hasXYSettlingTimeUnit() const Checks whether the optional XYSettlingTimeUnit attribute is present.
void	setXYResolution(const float & value, bool validate =true) Sets the value of the XYResolution attribute.
float	getXYResolution() const Returns the value of the XYResolution attribute.
void	resetXYResolution() Resets the XYResolution attribute to an unset state.
bool	hasXYResolution() const Checks whether the XYResolution attribute is present.
void	setXYZResolutionUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the XYZResolutionUnit attribute.
UnitsLength_TypePtr	getXYZResolutionUnit() const Returns the value of the XYZResolutionUnit attribute.
void	resetXYZResolutionUnit() Resets the XYZResolutionUnit attribute to an unset state.
bool	hasXYZResolutionUnit() const Checks whether the optional XYZResolutionUnit attribute is present.
void	setXYPositionLinearityError(const float & value, bool validate =true) Sets the value of the XYPositionLinearityError attribute.
float	getXYPositionLinearityError() const Returns the value of the XYPositionLinearityError attribute.
void	resetXYPositionLinearityError() Resets the XYPositionLinearityError attribute to an unset state.
bool	hasXYPositionLinearityError() const Checks whether the XYPositionLinearityError attribute is present.

Public Functions inherited from Inscoper::NBO::SamplePositioning_Type

	Name
	SamplePositioning_Type()
	~SamplePositioning_Type()
void	setID(const Inscoper::NBO::SamplePositioningID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
SamplePositioningID_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	setEncoded(const Inscoper::NBO::Encoded_TypePtr & value, bool validate =true) Sets the value of the Encoded attribute.
Encoded_TypePtr	getEncoded() const Returns the value of the Encoded attribute.
void	resetEncoded() Resets the Encoded attribute to an unset state.
bool	hasEncoded() const Checks whether the optional Encoded attribute is present.
void	setMotorized(const bool & value, bool validate =true) Sets the value of the Motorized attribute.
bool	getMotorized() const Returns the value of the Motorized attribute.
void	resetMotorized() Resets the Motorized attribute to an unset state.
bool	hasMotorized() const Checks whether the Motorized attribute is present.
void	setZMaxVelocity(const float & value, bool validate =true) Sets the value of the ZMaxVelocity attribute.
float	getZMaxVelocity() const Returns the value of the ZMaxVelocity attribute.
void	resetZMaxVelocity() Resets the ZMaxVelocity attribute to an unset state.
bool	hasZMaxVelocity() const Checks whether the ZMaxVelocity attribute is present.
void	setZMaxVelocityUnit(const Inscoper::NBO::UnitsVelocity_TypePtr & value, bool validate =true) Sets the value of the ZMaxVelocityUnit attribute.
UnitsVelocity_TypePtr	getZMaxVelocityUnit() const Returns the value of the ZMaxVelocityUnit attribute.
void	resetZMaxVelocityUnit() Resets the ZMaxVelocityUnit attribute to an unset state.
bool	hasZMaxVelocityUnit() const Checks whether the optional ZMaxVelocityUnit attribute is present.
void	setZRepeatability(const float & value, bool validate =true) Sets the value of the ZRepeatability attribute.
float	getZRepeatability() const Returns the value of the ZRepeatability attribute.
void	resetZRepeatability() Resets the ZRepeatability attribute to an unset state.
bool	hasZRepeatability() const Checks whether the ZRepeatability attribute is present.
void	setZRepeatabilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ZRepeatabilityUnit attribute.
UnitsLength_TypePtr	getZRepeatabilityUnit() const Returns the value of the ZRepeatabilityUnit attribute.
void	resetZRepeatabilityUnit() Resets the ZRepeatabilityUnit attribute to an unset state.
bool	hasZRepeatabilityUnit() const Checks whether the optional ZRepeatabilityUnit attribute is present.
void	setZTravelRange(const float & value, bool validate =true) Sets the value of the ZTravelRange attribute.
float	getZTravelRange() const Returns the value of the ZTravelRange attribute.
void	resetZTravelRange() Resets the ZTravelRange attribute to an unset state.
bool	hasZTravelRange() const Checks whether the ZTravelRange attribute is present.
void	setZTravelRangeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ZTravelRangeUnit attribute.
UnitsLength_TypePtr	getZTravelRangeUnit() const Returns the value of the ZTravelRangeUnit attribute.
void	resetZTravelRangeUnit() Resets the ZTravelRangeUnit attribute to an unset state.
bool	hasZTravelRangeUnit() const Checks whether the optional ZTravelRangeUnit attribute is present.
void	setMovementAxes(const Inscoper::NBO::StageMovementAxes_TypePtr & value, bool validate =true) Sets the value of the MovementAxes attribute.
StageMovementAxes_TypePtr	getMovementAxes() const Returns the value of the MovementAxes attribute.
void	resetMovementAxes() Resets the MovementAxes attribute to an unset state.
bool	hasMovementAxes() const Checks whether the optional MovementAxes attribute is present.
void	setBuiltIn(const bool & value, bool validate =true) Sets the value of the BuiltIn attribute.
bool	getBuiltIn() const Returns the value of the BuiltIn attribute.
void	resetBuiltIn() Resets the BuiltIn attribute to an unset state.
bool	hasBuiltIn() const Checks whether the BuiltIn attribute is present.
void	setZReproducibility(const float & value, bool validate =true) Sets the value of the ZReproducibility attribute.
float	getZReproducibility() const Returns the value of the ZReproducibility attribute.
void	resetZReproducibility() Resets the ZReproducibility attribute to an unset state.
bool	hasZReproducibility() const Checks whether the ZReproducibility attribute is present.
void	setZReproducibilityUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ZReproducibilityUnit attribute.
UnitsLength_TypePtr	getZReproducibilityUnit() const Returns the value of the ZReproducibilityUnit attribute.
void	resetZReproducibilityUnit() Resets the ZReproducibilityUnit attribute to an unset state.
bool	hasZReproducibilityUnit() const Checks whether the optional ZReproducibilityUnit attribute is present.
void	setZSettlingTime(const float & value, bool validate =true) Sets the value of the ZSettlingTime attribute.
float	getZSettlingTime() const Returns the value of the ZSettlingTime attribute.
void	resetZSettlingTime() Resets the ZSettlingTime attribute to an unset state.
bool	hasZSettlingTime() const Checks whether the ZSettlingTime attribute is present.
void	setZSettlingTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the ZSettlingTimeUnit attribute.
UnitsTime_TypePtr	getZSettlingTimeUnit() const Returns the value of the ZSettlingTimeUnit attribute.
void	resetZSettlingTimeUnit() Resets the ZSettlingTimeUnit attribute to an unset state.
bool	hasZSettlingTimeUnit() const Checks whether the optional ZSettlingTimeUnit attribute is present.
void	setZResolution(const float & value, bool validate =true) Sets the value of the ZResolution attribute.
float	getZResolution() const Returns the value of the ZResolution attribute.
void	resetZResolution() Resets the ZResolution attribute to an unset state.
bool	hasZResolution() const Checks whether the ZResolution attribute is present.
void	setZResolutionUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the ZResolutionUnit attribute.
UnitsLength_TypePtr	getZResolutionUnit() const Returns the value of the ZResolutionUnit attribute.
void	resetZResolutionUnit() Resets the ZResolutionUnit attribute to an unset state.
bool	hasZResolutionUnit() const Checks whether the optional ZResolutionUnit attribute is present.
void	setZPositionLinearityError(const float & value, bool validate =true) Sets the value of the ZPositionLinearityError attribute.
float	getZPositionLinearityError() const Returns the value of the ZPositionLinearityError attribute.
void	resetZPositionLinearityError() Resets the ZPositionLinearityError attribute to an unset state.
bool	hasZPositionLinearityError() const Checks whether the ZPositionLinearityError attribute is present.
void	setType(const Inscoper::NBO::PositioningType_TypePtr & value, bool validate =true) Sets the value of the Type attribute.
PositioningType_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	setRotationAngle(const float & value, bool validate =true) Sets the value of the RotationAngle attribute.
float	getRotationAngle() const Returns the value of the RotationAngle attribute.
void	resetRotationAngle() Resets the RotationAngle attribute to an unset state.
bool	hasRotationAngle() const Checks whether the RotationAngle attribute is present.
void	setRotationAngleUnit(const Inscoper::NBO::UnitsAngle_TypePtr & value, bool validate =true) Sets the value of the RotationAngleUnit attribute.
UnitsAngle_TypePtr	getRotationAngleUnit() const Returns the value of the RotationAngleUnit attribute.
void	resetRotationAngleUnit() Resets the RotationAngleUnit attribute to an unset state.
bool	hasRotationAngleUnit() const Checks whether the optional RotationAngleUnit 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.

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

Represents the XML element PiezoElectricStage.

This describes an optional piezoelectric-driven sample nano-positioning device associated with this Instrument. These devices typically achieve higher precision, accuracy and speed with respect to traditional Mechanical Stages.

Public Functions Documentation¶

function PiezoElectricStage¶

function ~PiezoElectricStage¶

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

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

Cast a NBOBaseClass to a PiezoElectricStage.

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