StageLabel

Bases: NBOBaseClass

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.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
StageLabel	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setName(value, validate=True)

Sets the value of the Name attribute.

A User-defined Name for this Stage Label.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getName()

Returns the value of the Name attribute.

A User-defined Name for this Stage Label.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this Stage Label.

hasName()

Checks whether the Name attribute is present.

A User-defined Name for this Stage Label.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getNameAllowedValues() staticmethod

Returns the allowed values for this attribut.

A User-defined Name for this Stage Label.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setX(value, validate=True)

Sets the value of the X attribute.

The X position of this StageLabel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getX()

Returns the value of the X attribute.

The X position of this StageLabel.

Returns:

Type	Description
float	The value of the attribute

resetX()

Resets the X attribute to an unset state.

The X position of this StageLabel.

hasX()

Checks whether the X attribute is present.

The X position of this StageLabel.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

setXUnits(value, validate=True)

Sets the value of the XUnits attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getXUnits()

Returns the value of the XUnits attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetXUnits()

Resets the XUnits attribute to an unset state.

No description available in the XSD standard.

hasXUnits()

Checks whether the optional XUnits attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setY(value, validate=True)

Sets the value of the Y attribute.

The Y position of this StageLabel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getY()

Returns the value of the Y attribute.

The Y position of this StageLabel.

Returns:

Type	Description
float	The value of the attribute

resetY()

Resets the Y attribute to an unset state.

The Y position of this StageLabel.

hasY()

Checks whether the Y attribute is present.

The Y position of this StageLabel.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

setYUnits(value, validate=True)

Sets the value of the YUnits attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getYUnits()

Returns the value of the YUnits attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetYUnits()

Resets the YUnits attribute to an unset state.

No description available in the XSD standard.

hasYUnits()

Checks whether the optional YUnits attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setZ(value, validate=True)

Sets the value of the Z attribute.

The Z position of this StageLabel.

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getZ()

Returns the value of the Z attribute.

The Z position of this StageLabel.

Returns:

Type	Description
float	The value of the attribute

resetZ()

Resets the Z attribute to an unset state.

The Z position of this StageLabel.

hasZ()

Checks whether the Z attribute is present.

The Z position of this StageLabel.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

setZUnits(value, validate=True)

Sets the value of the ZUnits attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsLength_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getZUnits()

Returns the value of the ZUnits attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetZUnits()

Resets the ZUnits attribute to an unset state.

No description available in the XSD standard.

hasZUnits()

Checks whether the optional ZUnits attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise