LightSensor
Bases: ManufacturerSpec_Type
Represents the XML element LightSensor.
A tool, such as the Meta-Max calibration toold developed by the 4D Nucleome Imaging Standards Working Group, used to perform an intensity calibration procedure.
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 |
setID(value)
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 |
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)
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 |
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 |
setLastCalibrationDate(value)
Sets the value of the LastCalibrationDate attribute.
This field records the Date in which the most recent Calibration Procedure of this Light Sensor was performed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getLastCalibrationDate()
Returns the value of the LastCalibrationDate attribute.
This field records the Date in which the most recent Calibration Procedure of this Light Sensor was performed.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetLastCalibrationDate()
Resets the LastCalibrationDate attribute to an unset state.
This field records the Date in which the most recent Calibration Procedure of this Light Sensor was performed.
hasLastCalibrationDate()
Checks whether the optional LastCalibrationDate attribute is present.
This field records the Date in which the most recent Calibration Procedure of this Light Sensor was performed.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setAnnotationRef(value)
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
|
LightSensor_InlineAnnotationRef
|
The value to set |
required |
getAnnotationRef()
Returns the value of the AnnotationRef element.
This is a simple multi-line comment or annotation describing this component.
Returns:
| Type | Description |
|---|---|
LightSensor_InlineAnnotationRef
|
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 |