DNAOrigami
Bases: OpticalCalibrationStandard_Type
Represents the XML element DNAOrigami.
This element describes an Standard Test Slide constructed using the DNA Origami technique.
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)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setSize(value)
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 |
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 |
setSizeUnit(value)
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 |
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)
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 |
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)
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 |
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 |