DNAOrigami

Bases: OpticalCalibrationStandard_Type

Represents the XML element DNAOrigami.

This element describes an Standard Test Slide constructed using the DNA Origami technique.

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

setSize(value, validate=True)

Sets the value of the Size attribute.

This field capture the Full Width at Half Maximum (FWHM) of the fluorescence emitters associated with this DNA Origami-based microscopy standard slide.

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

getSize()

Returns the value of the Size attribute.

This field capture the Full Width at Half Maximum (FWHM) of the fluorescence emitters associated with this DNA Origami-based microscopy standard slide.

Returns:

Type	Description
float	The value of the attribute

resetSize()

Resets the Size attribute to an unset state.

This field capture the Full Width at Half Maximum (FWHM) of the fluorescence emitters associated with this DNA Origami-based microscopy standard slide.

hasSize()

Checks whether the Size attribute is present.

This field capture the Full Width at Half Maximum (FWHM) of the fluorescence emitters associated with this DNA Origami-based microscopy standard slide.

Returns:

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

setSizeUnit(value, validate=True)

Sets the value of the SizeUnit 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

getSizeUnit()

Returns the value of the SizeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetSizeUnit()

Resets the SizeUnit attribute to an unset state.

No description available in the XSD standard.

hasSizeUnit()

Checks whether the optional SizeUnit attribute is present.

No description available in the XSD standard.

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 captures the type of fluorescence emitter(s) associated with this DNA Origami-based Optical Calibration Standard used in this case. Options include Point-Source and Nanoruler.

Parameters:

Name	Type	Description	Default
value	DNAOrigamiEmitterType_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 captures the type of fluorescence emitter(s) associated with this DNA Origami-based Optical Calibration Standard used in this case. Options include Point-Source and Nanoruler.

Returns:

Type	Description
DNAOrigamiEmitterType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field captures the type of fluorescence emitter(s) associated with this DNA Origami-based Optical Calibration Standard used in this case. Options include Point-Source and Nanoruler.

hasType()

Checks whether the optional Type attribute is present.

This field captures the type of fluorescence emitter(s) associated with this DNA Origami-based Optical Calibration Standard used in this case. Options include Point-Source and Nanoruler.

Returns:

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

setDescription(value, validate=True)

Sets the value of the Description element.

No description available in the XSD standard.

Parameters:

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

getDescription()

Returns the value of the Description element.

No description available in the XSD standard.

Returns:

Type	Description
Description	The value of the element

resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

hasDescription()

Checks whether the optional Description element is present.

No description available in the XSD standard.

Returns:

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