Adjustment

Adjustment dataclass

Adjustment(details: str, date: date)

An adjustment of the equipment.

An example of an adjustment is cleaning the equipment (e.g., a spectral filter) and then performing another calibration measurement.

This XML element is found in component.

Parameters:

Name	Type	Description	Default
details	str	The details of the adjustment that was performed.	required
date	date	The date that the adjustment was performed.	required

date instance-attribute

date: date

The date that the adjustment was performed.

details instance-attribute

details: str

The details of the adjustment that was performed.

from_xml classmethod

from_xml(element: Element[str]) -> Adjustment

Convert an XML element into a Adjustment instance.

Parameters:

Name	Type	Description	Default
element	Element[str]	An <adjustment> XML element from an equipment register (see component).	required

Returns:

Type	Description
Adjustment	The Adjustment instance.

Source code in src/msl/equipment/schema.py

@classmethod
def from_xml(cls, element: Element[str]) -> Adjustment:
    """Convert an XML element into a [Adjustment][msl.equipment.schema.Adjustment] instance.

    Args:
        element: An `<adjustment>` XML element from an equipment register
            (see [component][type_component]).

    Returns:
        The [Adjustment][msl.equipment.schema.Adjustment] instance.
    """
    return cls(details=element.text or "", date=_date.fromisoformat(element.attrib["date"]))

to_xml

to_xml() -> Element[str]

Convert the Adjustment class into an XML element.

Returns:

Type	Description
Element[str]	The Adjustment as an XML element.

Source code in src/msl/equipment/schema.py

def to_xml(self) -> Element[str]:
    """Convert the [Adjustment][msl.equipment.schema.Adjustment] class into an XML element.

    Returns:
        The [Adjustment][msl.equipment.schema.Adjustment] as an XML element.
    """
    e = Element("adjustment", attrib={"date": self.date.isoformat()})
    e.text = self.details
    return e