MicroscopeStand_Type

Bases: ManufacturerSpec_Type

Represents the XML complex type MicroscopeStand.

This element refers to the core structure of this Microscope, which might also be referred to as Body, Frame, or Platform.

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
MicroscopeStand_Type	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

setID(value, validate=True)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

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

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LSID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

setName(value, validate=True)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	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 component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

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

setType(value, validate=True)

Sets the value of the Type attribute.

This field describes the general category to which this Microscope belongs. A Compound Microscope is a Microscope in which the primary image is generated by an objective or an objective and a tube-lens, and in which the Sample is observed through an eyepiece. A Custom Microscope is specially designed for specialized purposes. An Electrophysiology Microscope is a Microscope dedicated to electrophysiological observation and manipulation. A Lightsheet Microscope is a Microscope in which in contrast to epifluorescence microscopy only a thin slice (usually a few hundred nanometers to a few micrometers) of the sample is illuminated perpendicularly to the direction of observation. A Stereo Microscope (also known as Dissecting Microscope) is a low-power, binocular Microscope with long free working distance used for dissecting. Generally in this type of Microscope the object is observed by each eye from a slightly different angle, thus causing stereoscopic perception.

Parameters:

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

getType()

Returns the value of the Type attribute.

This field describes the general category to which this Microscope belongs. A Compound Microscope is a Microscope in which the primary image is generated by an objective or an objective and a tube-lens, and in which the Sample is observed through an eyepiece. A Custom Microscope is specially designed for specialized purposes. An Electrophysiology Microscope is a Microscope dedicated to electrophysiological observation and manipulation. A Lightsheet Microscope is a Microscope in which in contrast to epifluorescence microscopy only a thin slice (usually a few hundred nanometers to a few micrometers) of the sample is illuminated perpendicularly to the direction of observation. A Stereo Microscope (also known as Dissecting Microscope) is a low-power, binocular Microscope with long free working distance used for dissecting. Generally in this type of Microscope the object is observed by each eye from a slightly different angle, thus causing stereoscopic perception.

Returns:

Type	Description
MicroscopeType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field describes the general category to which this Microscope belongs. A Compound Microscope is a Microscope in which the primary image is generated by an objective or an objective and a tube-lens, and in which the Sample is observed through an eyepiece. A Custom Microscope is specially designed for specialized purposes. An Electrophysiology Microscope is a Microscope dedicated to electrophysiological observation and manipulation. A Lightsheet Microscope is a Microscope in which in contrast to epifluorescence microscopy only a thin slice (usually a few hundred nanometers to a few micrometers) of the sample is illuminated perpendicularly to the direction of observation. A Stereo Microscope (also known as Dissecting Microscope) is a low-power, binocular Microscope with long free working distance used for dissecting. Generally in this type of Microscope the object is observed by each eye from a slightly different angle, thus causing stereoscopic perception.

hasType()

Checks whether the optional Type attribute is present.

This field describes the general category to which this Microscope belongs. A Compound Microscope is a Microscope in which the primary image is generated by an objective or an objective and a tube-lens, and in which the Sample is observed through an eyepiece. A Custom Microscope is specially designed for specialized purposes. An Electrophysiology Microscope is a Microscope dedicated to electrophysiological observation and manipulation. A Lightsheet Microscope is a Microscope in which in contrast to epifluorescence microscopy only a thin slice (usually a few hundred nanometers to a few micrometers) of the sample is illuminated perpendicularly to the direction of observation. A Stereo Microscope (also known as Dissecting Microscope) is a low-power, binocular Microscope with long free working distance used for dissecting. Generally in this type of Microscope the object is observed by each eye from a slightly different angle, thus causing stereoscopic perception.

Returns:

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

setOrigin(value, validate=True)

Sets the value of the Origin attribute.

This field describes the origin of this Microscope Stand. Specifically it specifies whether this Microscope Stand was purchased from a Commercial vendor and is being used as-is (i.e., Commercial- as is), purchased from a Commercial vendor and subsequently Modified for a specialized application (i.e., Commercial- custom-modified) or entirely Custom-built from scratch (i.e., Custom-built).

Parameters:

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

getOrigin()

Returns the value of the Origin attribute.

This field describes the origin of this Microscope Stand. Specifically it specifies whether this Microscope Stand was purchased from a Commercial vendor and is being used as-is (i.e., Commercial- as is), purchased from a Commercial vendor and subsequently Modified for a specialized application (i.e., Commercial- custom-modified) or entirely Custom-built from scratch (i.e., Custom-built).

Returns:

Type	Description
Origin_Type	The value of the attribute

resetOrigin()

Resets the Origin attribute to an unset state.

This field describes the origin of this Microscope Stand. Specifically it specifies whether this Microscope Stand was purchased from a Commercial vendor and is being used as-is (i.e., Commercial- as is), purchased from a Commercial vendor and subsequently Modified for a specialized application (i.e., Commercial- custom-modified) or entirely Custom-built from scratch (i.e., Custom-built).

hasOrigin()

Checks whether the optional Origin attribute is present.

This field describes the origin of this Microscope Stand. Specifically it specifies whether this Microscope Stand was purchased from a Commercial vendor and is being used as-is (i.e., Commercial- as is), purchased from a Commercial vendor and subsequently Modified for a specialized application (i.e., Commercial- custom-modified) or entirely Custom-built from scratch (i.e., Custom-built).

Returns:

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

setEyePieceFieldNumber(value, validate=True)

Sets the value of the EyePieceFieldNumber attribute.

The Field Number represents the diaphragm size of the Microscope eyepiece expressed in mm.

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

getEyePieceFieldNumber()

Returns the value of the EyePieceFieldNumber attribute.

The Field Number represents the diaphragm size of the Microscope eyepiece expressed in mm.

Returns:

Type	Description
float	The value of the attribute

resetEyePieceFieldNumber()

Resets the EyePieceFieldNumber attribute to an unset state.

The Field Number represents the diaphragm size of the Microscope eyepiece expressed in mm.

hasEyePieceFieldNumber()

Checks whether the EyePieceFieldNumber attribute is present.

The Field Number represents the diaphragm size of the Microscope eyepiece expressed in mm.

Returns:

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

setAnnotationRef(value, validate=True)

Sets the value of the AnnotationRef element.

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

Parameters:

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

getAnnotationRef()

Returns the value of the AnnotationRef element.

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

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

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

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

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

Returns:

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