Module nari.types.event.instance

Classes that represent director commands to manage instance duty state

"""Classes that represent director commands to manage instance duty state"""
from enum import Enum, auto

from nari.types import Timestamp
from nari.types.event import Event


# pylint: disable=invalid-name
class Fade(Enum):
    """Enums for fade in/out"""
    In = auto()
    Out = auto()


class BarrierState(Enum):
    """Enums for barrier state"""
    down = auto()
    up = auto()
# pylint: enable=invalid-name


class InstanceComplete(Event): # pylint: disable=too-few-public-methods
    """Represents an instance being complete"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id

    def __repr__(self):
        return '<InstanceComplete>'


class InstanceVote(Event): # pylint: disable=too-few-public-methods
    """Represents the vote start"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id

    def __repr__(self):
        return '<InstanceVote>'


class InstanceFade(Event): # pylint: disable=too-few-public-methods
    """Represents fade out/in"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                 state: Fade,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id
        self.state = state

    def __repr__(self):
        return '<InstanceFade>'


class BarrierToggle(Event): # pylint: disable=too-few-public-methods
    """Represents a barrier changing state"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                 state: BarrierState,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id
        self.state = state

    def __repr__(self):
        return '<BarrierToggle>'


class InstanceInit(Event): # pylint: disable=too-few-public-methods
    """Represents entering an instance"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id

    def __repr__(self):
        return '<InstanceInit>'

Classes

class BarrierState (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enums for barrier state

Expand source code

class BarrierState(Enum):
    """Enums for barrier state"""
    down = auto()
    up = auto()

Ancestors

• enum.Enum

Class variables

var down

var up

class BarrierToggle (*, timestamp: int, instance_id: int, state: BarrierState)

Represents a barrier changing state

Expand source code

class BarrierToggle(Event): # pylint: disable=too-few-public-methods
    """Represents a barrier changing state"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                 state: BarrierState,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id
        self.state = state

    def __repr__(self):
        return '<BarrierToggle>'

Ancestors

• Event

class Fade (value, names=None, *, module=None, qualname=None, type=None, start=1)

Enums for fade in/out

Expand source code

class Fade(Enum):
    """Enums for fade in/out"""
    In = auto()
    Out = auto()

Ancestors

• enum.Enum

Class variables

var In

var Out

class InstanceComplete (*, timestamp: int, instance_id: int)

Represents an instance being complete

Expand source code

class InstanceComplete(Event): # pylint: disable=too-few-public-methods
    """Represents an instance being complete"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id

    def __repr__(self):
        return '<InstanceComplete>'

Ancestors

• Event

class InstanceFade (*, timestamp: int, instance_id: int, state: Fade)

Represents fade out/in

Expand source code

class InstanceFade(Event): # pylint: disable=too-few-public-methods
    """Represents fade out/in"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                 state: Fade,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id
        self.state = state

    def __repr__(self):
        return '<InstanceFade>'

Ancestors

• Event

class InstanceInit (*, timestamp: int, instance_id: int)

Represents entering an instance

Expand source code

class InstanceInit(Event): # pylint: disable=too-few-public-methods
    """Represents entering an instance"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id

    def __repr__(self):
        return '<InstanceInit>'

Ancestors

• Event

class InstanceVote (*, timestamp: int, instance_id: int)

Represents the vote start

Expand source code

class InstanceVote(Event): # pylint: disable=too-few-public-methods
    """Represents the vote start"""
    def __init__(self, *,
                 timestamp: Timestamp,
                 instance_id: int,
                ):
        super().__init__(timestamp)
        self.instance_id = instance_id

    def __repr__(self):
        return '<InstanceVote>'

Ancestors

• Event