Module csw.EventKey

Classes

class EventKey (source: Prefix,
eventName: EventName)

Expand source code

@dataclass
class EventKey:
    """
    A wrapper class representing the key for an event

    Args:
        source (Prefix): represents the prefix of the component that publishes this event
        eventName (EventName): represents the name of the event
    """
    source: Prefix
    eventName: EventName

    def __str__(self):
        return f"{str(self.source)}.{self.eventName.name}"

    @classmethod
    def from_str(class_object, eventKeyStr: str):
        i = eventKeyStr.rindex('.')
        return EventKey(Prefix.from_str(eventKeyStr[:i]), EventName(eventKeyStr[i+1:]))

A wrapper class representing the key for an event

Args

source : Prefix

represents the prefix of the component that publishes this event

eventName : EventName

represents the name of the event

Static methods

def from_str(eventKeyStr: str)

Instance variables

var eventName : EventName

The type of the None singleton.

var source : Prefix

The type of the None singleton.