yr.Alarm.set

Contents

yr.Alarm.set#

Alarm.set(alarm_info: AlarmInfo) → None[source]#

Set alarm to the given info.

Parameters:

alarm_info (AlarmInfo) – An object containing detailed alarm information.

Raises:

  • ValueError – Invoked in the driver.

  • ValueError – If alarm_name is None.

Example

>>> import yr
>>> import time
>>> config = yr.Config(enable_metrics=True)
>>> config.log_level="DEBUG":378
>>> yr.init(config)

>>> @yr.instance
>>> class Actor:
>>>    def __init__(self):
>>>        self.state = 0
>>>        self.name = "aa"

>>>    def add(self, value):
>>>        self.state += value
>>>        if self.state > 10:
>>>            alarm_info = yr.AlarmInfo(alarm_name="aad")
>>>            alarm = yr.Alarm(self.name, description="")
>>>            alarm.set(alarm_info)
>>>        return self.state
>>>
>>>    def get(self):
>>>        return self.state
>>>
>>> actor1 = Actor.options(name="actor1").invoke()
>>>
>>> print("actor1 add 5:", yr.get(actor1.add.invoke(5)))
>>> print("actor1 add 7:", yr.get(actor1.add.invoke(7)))
>>> print("actor1 state:", yr.get(actor1.get.invoke()))
Contents