StageInsert

Bases: ManufacturerSpec_Type

Represents the XML element StageInsert.

This element describes an optional Stage Insert mounted on the Stage.

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
StageInsert	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	StageInsertID_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
StageInsertID_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

setSampleHolderType(value, validate=True)

Sets the value of the SampleHolderType attribute.

This field describes the type of Specimen Holder this Stage Insert is designed to hold.

Parameters:

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

getSampleHolderType()

Returns the value of the SampleHolderType attribute.

This field describes the type of Specimen Holder this Stage Insert is designed to hold.

Returns:

Type	Description
SampleHolderType_Type	The value of the attribute

resetSampleHolderType()

Resets the SampleHolderType attribute to an unset state.

This field describes the type of Specimen Holder this Stage Insert is designed to hold.

hasSampleHolderType()

Checks whether the optional SampleHolderType attribute is present.

This field describes the type of Specimen Holder this Stage Insert is designed to hold.

Returns:

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

setTemperatureControlled(value, validate=True)

Sets the value of the TemperatureControlled attribute.

This field records whether this Stage Insert is Temperature Controlled (True), or not (False).

Parameters:

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

getTemperatureControlled()

Returns the value of the TemperatureControlled attribute.

This field records whether this Stage Insert is Temperature Controlled (True), or not (False).

Returns:

Type	Description
boolean	The value of the attribute

resetTemperatureControlled()

Resets the TemperatureControlled attribute to an unset state.

This field records whether this Stage Insert is Temperature Controlled (True), or not (False).

hasTemperatureControlled()

Checks whether the TemperatureControlled attribute is present.

This field records whether this Stage Insert is Temperature Controlled (True), or not (False).

Returns:

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

setNumberOfSlots(value, validate=True)

Sets the value of the NumberOfSlots attribute.

This field describes the number of Specimen Holder slots on this Stage Insert.

Parameters:

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

getNumberOfSlots()

Returns the value of the NumberOfSlots attribute.

This field describes the number of Specimen Holder slots on this Stage Insert.

Returns:

Type	Description
int	The value of the attribute

resetNumberOfSlots()

Resets the NumberOfSlots attribute to an unset state.

This field describes the number of Specimen Holder slots on this Stage Insert.

hasNumberOfSlots()

Checks whether the NumberOfSlots attribute is present.

This field describes the number of Specimen Holder slots on this Stage Insert.

Returns:

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

setAnnotationRef(value, validate=True)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

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.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

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