Module scenariogeneration.xosc.enumerations

scenariogeneration https://github.com/pyoscx/scenariogeneration

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

Copyright (c) 2022 The scenariogeneration Authors.

"""
  scenariogeneration
  https://github.com/pyoscx/scenariogeneration

  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at https://mozilla.org/MPL/2.0/.

  Copyright (c) 2022 The scenariogeneration Authors.

"""
XMLNS = "http://www.w3.org/2001/XMLSchema-instance"
XSI = "OpenScenario.xsd"

import re
from .exceptions import OpenSCENARIOVersionError
from os import error
import warnings

_MINOR_VERSION = 2


class VersionBase:
    """base class for checking different versions of OpenSCENARIO"""

    version_major = 1
    version_minor = _MINOR_VERSION

    def isVersion(self, major=1, minor=_MINOR_VERSION):
        return major == self.version_major and minor == self.version_minor

    def isVersionEqLess(self, major=1, minor=_MINOR_VERSION):
        return major >= self.version_major and minor >= self.version_minor

    def isVersionEqLarger(self, major=1, minor=_MINOR_VERSION):
        return major <= self.version_major and minor <= self.version_minor

    def setVersion(self, major=1, minor=_MINOR_VERSION):
        VersionBase.version_major = major
        VersionBase.version_minor = minor


class _OscEnum(VersionBase):
    """custom "enum" class to be able to handle different versions of the enums in OpenSCENARIO

    Parameters
    ----------
        name (str): enum name

        classname (str): name of the enum class (only used for printouts to help debugging)

        min_minor_version (int): how the relative distance should be calculated
            Default: 0

        max_minor_version (int): the max "minor version" where the enum is valid
            Default: Current Supported Version

    Attributes
    ----------
        name (str): enum name

        classname (str): name of the enum class (only used for printouts to help debugging)

        min_minor_version (int): how the relative distance should be calculated

        max_minor_version (int): the max "minor version" where the enum is valid

    Methods
    -------
        get_name()
            Returns the correct string of the Enum, will take care of versions

    """

    def __init__(
        self,
        classname,
        name,
        min_minor_version=0,
        max_minor_version=_MINOR_VERSION,
        replacement=None,
    ):
        """initalize the _OscEnum
        Parameters
        ----------
            name (str): enum name

            classname (str): name of the enum class (only used for printouts to help debugging)

            min_minor_version (int): how the relative distance should be calculated
                Default: 0

            max_minor_version (int): the max "minor version" where the enum is valid
                Default: Current Supported Version

            replacement (str): can be used is the enum has been replaced to make transitions go easier
        """

        self.name = name
        self.classname = classname
        self.min_minor_version = min_minor_version
        self.max_minor_version = max_minor_version
        self.replacement = replacement

    def __eq__(self, other):
        if isinstance(other, _OscEnum):
            if self.name == other.name and self.classname == other.classname:
                return True
        return False

    def get_name(self):
        """method that should be used when using the _OscEnum to get the string, will check version of the enum to see if it is used correctly with the used version

        Returns
        -------
        name (str)
        """
        if self.min_minor_version > self.version_minor:
            raise OpenSCENARIOVersionError(
                self.classname
                + "."
                + self.name
                + " is not part of OpenSCENARIO V"
                + str(self.version_major)
                + "."
                + str(self.version_minor)
                + ", was introduced in V"
                + str(self.version_major)
                + "."
                + str(self.min_minor_version)
            )
        elif self.max_minor_version < self.version_minor:
            if self.replacement:
                warnings.warn(
                    self.classname
                    + "."
                    + self.name
                    + " is not part of OpenSCENARIO V"
                    + str(self.version_major)
                    + "."
                    + str(self.version_minor)
                    + ", was deprecated in V"
                    + str(self.version_major)
                    + "."
                    + str(self.max_minor_version)
                    + " and replaced with: "
                    + self.replacement
                )
                return self.name

            raise OpenSCENARIOVersionError(
                self.classname
                + "."
                + self.name
                + " is not part of OpenSCENARIO V"
                + str(self.version_major)
                + "."
                + str(self.version_minor)
                + ", was deprecated in V"
                + str(self.version_major)
                + "."
                + str(self.max_minor_version)
            )
        return self.name

    def __str__(self):
        return self.name


class _EnumMeta(type):
    """This class is used to add functionality to the Enum classes in the xosc module
    Note: this class should only be inherited

    """

    def __getitem__(self, name):
        return self.__dict__[name]


class CloudState(metaclass=_EnumMeta):
    """Enum for CloudState"""

    skyOff = _OscEnum("CloudState", "skyOff")
    free = _OscEnum("CloudState", "free")
    cloudy = _OscEnum("CloudState", "cloudy")
    overcast = _OscEnum("CloudState", "overcast")
    rainy = _OscEnum("CloudState", "rainy")


class ConditionEdge(metaclass=_EnumMeta):
    """Enum for ConditionEdge"""

    rising = _OscEnum("ConditionEdge", "rising")
    falling = _OscEnum("ConditionEdge", "falling")
    risingOrFalling = _OscEnum("ConditionEdge", "risingOrFalling")
    none = _OscEnum("ConditionEdge", "none")


class DynamicsDimension(metaclass=_EnumMeta):
    """Enum for DynamicsDimension"""

    rate = _OscEnum("DynamicsDimension", "rate")
    time = _OscEnum("DynamicsDimension", "time")
    distance = _OscEnum("DynamicsDimension", "distance")


class DynamicsShapes(metaclass=_EnumMeta):
    """Enum for DynamicsShapes"""

    linear = _OscEnum("DynamicsShapes", "linear")
    cubic = _OscEnum("DynamicsShapes", "cubic")
    sinusoidal = _OscEnum("DynamicsShapes", "sinusoidal")
    step = _OscEnum("DynamicsShapes", "step")


class FollowingMode(metaclass=_EnumMeta):
    """Enum for FollowingMode"""

    position = _OscEnum("FollowingMode", "position")
    follow = _OscEnum("FollowingMode", "follow")


class MiscObjectCategory(metaclass=_EnumMeta):
    """Enum for MiscObjectCategory"""

    none = _OscEnum("MiscObjectCategory", "none")
    obstacle = _OscEnum("MiscObjectCategory", "obstacle")
    pole = _OscEnum("MiscObjectCategory", "pole")
    tree = _OscEnum("MiscObjectCategory", "tree")
    vegetation = _OscEnum("MiscObjectCategory", "vegetation")
    barrier = _OscEnum("MiscObjectCategory", "barrier")
    building = _OscEnum("MiscObjectCategory", "building")
    parkingSpace = _OscEnum("MiscObjectCategory", "parkingSpace")
    patch = _OscEnum("MiscObjectCategory", "patch")
    railing = _OscEnum("MiscObjectCategory", "railing")
    grafficIsland = _OscEnum("MiscObjectCategory", "grafficIsland")
    crosswalk = _OscEnum("MiscObjectCategory", "crosswalk")
    streetLamp = _OscEnum("MiscObjectCategory", "streetLamp")
    gantry = _OscEnum("MiscObjectCategory", "gantry")
    soundBarrier = _OscEnum("MiscObjectCategory", "soundBarrier")
    wind = _OscEnum("MiscObjectCategory", "wind", max_minor_version=0)
    roadMark = _OscEnum("MiscObjectCategory", "roadMark")


class ObjectType(metaclass=_EnumMeta):
    """Enum for ObjectType"""

    pedestrian = _OscEnum("ObjectType", "pedestrian")
    vehicle = _OscEnum("ObjectType", "vehicle")
    miscellaneous = _OscEnum("ObjectType", "miscellaneous")
    external = _OscEnum("ObjectType", "external", min_minor_version=1)


class ParameterType(metaclass=_EnumMeta):
    """Enum for ParameterType"""

    integer = _OscEnum(
        "ParameterType", "integer", max_minor_version=1, replacement="int"
    )
    int = _OscEnum("ParameterType", "int", min_minor_version=2)
    double = _OscEnum("ParameterType", "double")
    string = _OscEnum("ParameterType", "string")
    unsighedInt = _OscEnum("ParameterType", "unsighedInt")
    unsighedShort = _OscEnum("ParameterType", "unsighedShort")
    boolean = _OscEnum("ParameterType", "boolean")
    dateTime = _OscEnum("ParameterType", "dateTime")


class PedestrianCategory(metaclass=_EnumMeta):
    """Enum for PedestrianCategory"""

    pedestrian = _OscEnum("PedestrianCategory", "pedestrian")
    wheelchair = _OscEnum("PedestrianCategory", "wheelchair")
    animal = _OscEnum("PedestrianCategory", "animal")


class PrecipitationType(metaclass=_EnumMeta):
    """Enum for PercipitationType"""

    dry = _OscEnum("PrecipitationType", "dry")
    rain = _OscEnum("PrecipitationType", "rain")
    snow = _OscEnum("PrecipitationType", "snow")


class Priority(metaclass=_EnumMeta):
    """Enum for Priority"""

    overwrite = _OscEnum(
        "Priority", "overwrite", max_minor_version=1, replacement="override"
    )
    override = _OscEnum("Priority", "override", min_minor_version=2)
    skip = _OscEnum("Priority", "skip")
    parallel = _OscEnum("Priority", "parallel")


class ReferenceContext(metaclass=_EnumMeta):
    """Enum for ReferenceContext"""

    relative = _OscEnum("ReferenceContext", "relative")
    absolute = _OscEnum("ReferenceContext", "absolute")


class RelativeDistanceType(metaclass=_EnumMeta):
    """Enum for RelativeDistanceType"""

    longitudinal = _OscEnum("RelativeDistanceType", "longitudinal")
    lateral = _OscEnum("RelativeDistanceType", "lateral")
    cartesianDistance = _OscEnum(
        "RelativeDistanceType", "cartesianDistance", max_minor_version=0
    )
    euclidianDistance = _OscEnum(
        "RelativeDistanceType", "euclidianDistance", min_minor_version=1
    )


class RouteStrategy(metaclass=_EnumMeta):
    """Enum for RouteStrategy"""

    fastest = _OscEnum("RouteStrategy", "fastest")
    shortest = _OscEnum("RouteStrategy", "shortest")
    leastIntersections = _OscEnum("RouteStrategy", "leastIntersections")
    random = _OscEnum("RouteStrategy", "random")


class Rule(metaclass=_EnumMeta):
    """Enum for Rule"""

    greaterThan = _OscEnum("Rule", "greaterThan")
    lessThan = _OscEnum("Rule", "lessThan")
    equalTo = _OscEnum("Rule", "equalTo")
    greaterOrEqual = _OscEnum("Rule", "greaterOrEqual", min_minor_version=1)
    lessOrEqual = _OscEnum("Rule", "lessOrEqual", min_minor_version=1)
    notEqualTo = _OscEnum("Rule", "notEqualTo", min_minor_version=1)


class SpeedTargetValueType(metaclass=_EnumMeta):
    """Enum for SpeedTargetValueType"""

    delta = _OscEnum("SpeedTargetValueType", "delta")
    factor = _OscEnum("SpeedTargetValueType", "factor")


class StoryboardElementState(metaclass=_EnumMeta):
    """Enum for StoryboardElementState"""

    startTransition = _OscEnum("StoryboardElementState", "startTransition")
    endTransition = _OscEnum("StoryboardElementState", "endTransition")
    stopTransition = _OscEnum("StoryboardElementState", "stopTransition")
    skipTransition = _OscEnum("StoryboardElementState", "skipTransition")
    completeState = _OscEnum("StoryboardElementState", "completeState")
    runningState = _OscEnum("StoryboardElementState", "runningState")
    standbyState = _OscEnum("StoryboardElementState", "standbyState")


class StoryboardElementType(metaclass=_EnumMeta):
    """Enum for StoryboardElementType"""

    story = _OscEnum("StoryboardElementType", "story")
    act = _OscEnum("StoryboardElementType", "act")
    maneuver = _OscEnum("StoryboardElementType", "maneuver")
    event = _OscEnum("StoryboardElementType", "event")
    action = _OscEnum("StoryboardElementType", "action")
    maneuverGroup = _OscEnum("StoryboardElementType", "maneuverGroup")


class TriggeringEntitiesRule(metaclass=_EnumMeta):
    """Enum for TriggeringEntitiesRule"""

    any = _OscEnum("TriggeringEntitiesRule", "any")
    all = _OscEnum("TriggeringEntitiesRule", "all")


class VehicleCategory(metaclass=_EnumMeta):
    """Enum for VehicleCategory"""

    car = _OscEnum("VehicleCategory", "car")
    van = _OscEnum("VehicleCategory", "van")
    truck = _OscEnum("VehicleCategory", "truck")
    trailer = _OscEnum("VehicleCategory", "trailer")
    semitrailer = _OscEnum("VehicleCategory", "semitrailer")
    bus = _OscEnum("VehicleCategory", "bus")
    motorbike = _OscEnum("VehicleCategory", "motorbike")
    bicycle = _OscEnum("VehicleCategory", "bicycle")
    train = _OscEnum("VehicleCategory", "train")
    tram = _OscEnum("VehicleCategory", "tram")


class CoordinateSystem(metaclass=_EnumMeta):
    """Enum for CoordinateSystem"""

    entity = _OscEnum("CoordinateSystem", "entity", min_minor_version=1)
    lane = _OscEnum("CoordinateSystem", "lane", min_minor_version=1)
    road = _OscEnum("CoordinateSystem", "road", min_minor_version=1)
    trajectory = _OscEnum("CoordinateSystem", "trajectory", min_minor_version=1)


class LateralDisplacement(metaclass=_EnumMeta):
    any = _OscEnum("LateralDisplacement", "any", min_minor_version=1)
    leftToReferencedEntity = _OscEnum(
        "LateralDisplacement", "leftToReferencedEntity", min_minor_version=1
    )
    rightToReferencedEntity = _OscEnum(
        "LateralDisplacement", "rightToReferencedEntity", min_minor_version=1
    )


class LongitudinalDisplacement(metaclass=_EnumMeta):
    any = _OscEnum("LongitudinalDisplacement", "any", min_minor_version=1)
    trailingReferencedEntity = _OscEnum(
        "LongitudinalDisplacement", "trailingReferencedEntity", min_minor_version=1
    )
    leadingReferencedEntity = _OscEnum(
        "LongitudinalDisplacement", "leadingReferencedEntity", min_minor_version=1
    )


class AutomaticGearType(metaclass=_EnumMeta):
    n = _OscEnum("AutomaticGearType", "n", min_minor_version=2)
    p = _OscEnum("AutomaticGearType", "p", min_minor_version=2)
    r = _OscEnum("AutomaticGearType", "r", min_minor_version=2)
    d = _OscEnum("AutomaticGearType", "d", min_minor_version=2)


class ControllerType(metaclass=_EnumMeta):
    lateral = _OscEnum("ControllerType", "lateral", min_minor_version=2)
    longitudinal = _OscEnum("ControllerType", "longitudinal", min_minor_version=2)
    lighting = _OscEnum("ControllerType", "lighting", min_minor_version=2)
    animation = _OscEnum("ControllerType", "animation", min_minor_version=2)
    movement = _OscEnum("ControllerType", "movement", min_minor_version=2)
    appearance = _OscEnum("ControllerType", "appearance", min_minor_version=2)
    all = _OscEnum("ControllerType", "all", min_minor_version=2)


class DirectionalDimension(metaclass=_EnumMeta):
    longitudinal = _OscEnum("DirectionalDimension", "longitudinal", min_minor_version=2)
    lateral = _OscEnum("DirectionalDimension", "lateral", min_minor_version=2)
    vertical = _OscEnum("DirectionalDimension", "vertical", min_minor_version=2)


class FractionalCloudCover(metaclass=_EnumMeta):
    zeroOktas = _OscEnum("FractionalCloudCover", "zeroOktas", min_minor_version=2)
    oneOktas = _OscEnum("FractionalCloudCover", "oneOktas", min_minor_version=2)
    twoOktas = _OscEnum("FractionalCloudCover", "twoOktas", min_minor_version=2)
    threeOktas = _OscEnum("FractionalCloudCover", "threeOktas", min_minor_version=2)
    fourOktas = _OscEnum("FractionalCloudCover", "fourOktas", min_minor_version=2)
    fiveOktas = _OscEnum("FractionalCloudCover", "fiveOktas", min_minor_version=2)
    sixOktas = _OscEnum("FractionalCloudCover", "sixOktas", min_minor_version=2)
    sevenOktas = _OscEnum("FractionalCloudCover", "sevenOktas", min_minor_version=2)
    eightOktas = _OscEnum("FractionalCloudCover", "eightOktas", min_minor_version=2)
    nineOktas = _OscEnum("FractionalCloudCover", "nineOktas", min_minor_version=2)


class LightMode(metaclass=_EnumMeta):
    on = _OscEnum("LightMode", "on", min_minor_version=2)
    off = _OscEnum("LightMode", "off", min_minor_version=2)
    flashing = _OscEnum("LightMode", "flashing", min_minor_version=2)


class PedestrianGestureType(metaclass=_EnumMeta):
    phoneCallRightHand = _OscEnum(
        "PedestrianGestureType", "phoneCallRightHand", min_minor_version=2
    )
    phoneCallLeftHand = _OscEnum(
        "PedestrianGestureType", "phoneCallLeftHand", min_minor_version=2
    )
    phoneTextRightHand = _OscEnum(
        "PedestrianGestureType", "phoneTextRightHand", min_minor_version=2
    )
    phoneTextLeftHand = _OscEnum(
        "PedestrianGestureType", "phoneTextLeftHand", min_minor_version=2
    )
    wavingRightArm = _OscEnum(
        "PedestrianGestureType", "wavingRightArm", min_minor_version=2
    )
    wavingLeftArm = _OscEnum(
        "PedestrianGestureType", "wavingLeftArm", min_minor_version=2
    )
    umbrellaRightHand = _OscEnum(
        "PedestrianGestureType", "umbrellaRightHand", min_minor_version=2
    )
    umbrellaLeftHand = _OscEnum(
        "PedestrianGestureType", "umbrellaLeftHand", min_minor_version=2
    )
    crossArms = _OscEnum("PedestrianGestureType", "crossArms", min_minor_version=2)
    coffeeRightHand = _OscEnum(
        "PedestrianGestureType", "coffeeRightHand", min_minor_version=2
    )
    coffeeLeftHand = _OscEnum(
        "PedestrianGestureType", "coffeeLeftHand", min_minor_version=2
    )
    sandwichRightHand = _OscEnum(
        "PedestrianGestureType", "sandwichRightHand", min_minor_version=2
    )
    sandwichLeftHand = _OscEnum(
        "PedestrianGestureType", "sandwichLeftHand", min_minor_version=2
    )


class PedestrianMotionType(metaclass=_EnumMeta):
    standing = _OscEnum("PedestrianMotionType", "standing", min_minor_version=2)
    sitting = _OscEnum("PedestrianMotionType", "sitting", min_minor_version=2)
    lying = _OscEnum("PedestrianMotionType", "lying", min_minor_version=2)
    squatting = _OscEnum("PedestrianMotionType", "squatting", min_minor_version=2)
    walking = _OscEnum("PedestrianMotionType", "walking", min_minor_version=2)
    running = _OscEnum("PedestrianMotionType", "running", min_minor_version=2)
    reeling = _OscEnum("PedestrianMotionType", "reeling", min_minor_version=2)
    crawling = _OscEnum("PedestrianMotionType", "crawling", min_minor_version=2)
    cycling = _OscEnum("PedestrianMotionType", "cycling", min_minor_version=2)
    jumping = _OscEnum("PedestrianMotionType", "jumping", min_minor_version=2)
    ducking = _OscEnum("PedestrianMotionType", "ducking", min_minor_version=2)
    bendingDown = _OscEnum("PedestrianMotionType", "bendingDown", min_minor_version=2)


class RoutingAlgorithm(metaclass=_EnumMeta):
    assignedRoute = _OscEnum("RoutingAlgorithm", "assignedRoute", min_minor_version=2)
    fastest = _OscEnum("RoutingAlgorithm", "fastest", min_minor_version=2)
    leastIntersections = _OscEnum(
        "RoutingAlgorithm", "leastIntersections", min_minor_version=2
    )
    shortest = _OscEnum("RoutingAlgorithm", "shortest", min_minor_version=2)
    undefined = _OscEnum("RoutingAlgorithm", "undefined", min_minor_version=2)


class VehicleComponentType(metaclass=_EnumMeta):
    hood = _OscEnum("VehicleComponentType", "hood", min_minor_version=2)
    trunk = _OscEnum("VehicleComponentType", "trunk", min_minor_version=2)
    doorFrontRight = _OscEnum(
        "VehicleComponentType", "doorFrontRight", min_minor_version=2
    )
    doorFrontLeft = _OscEnum(
        "VehicleComponentType", "doorFrontLeft", min_minor_version=2
    )
    doorRearRight = _OscEnum(
        "VehicleComponentType", "doorRearRight", min_minor_version=2
    )
    doorRearLeft = _OscEnum("VehicleComponentType", "doorRearLeft", min_minor_version=2)
    windowFrontRight = _OscEnum(
        "VehicleComponentType", "windowFrontRight", min_minor_version=2
    )
    windowFrontLeft = _OscEnum(
        "VehicleComponentType", "windowFrontLeft", min_minor_version=2
    )
    windowRearRight = _OscEnum(
        "VehicleComponentType", "windowRearRight", min_minor_version=2
    )
    windowRearLeft = _OscEnum(
        "VehicleComponentType", "windowRearLeft", min_minor_version=2
    )
    sideMirrors = _OscEnum("VehicleComponentType", "sideMirrors", min_minor_version=2)
    sideMirrorRight = _OscEnum(
        "VehicleComponentType", "sideMirrorRight", min_minor_version=2
    )
    sideMirrorLeft = _OscEnum(
        "VehicleComponentType", "sideMirrorLeft", min_minor_version=2
    )


class VehicleLightType(metaclass=_EnumMeta):
    daytimeRunningLights = _OscEnum(
        "VehicleLightType", "daytimeRunningLights", min_minor_version=2
    )
    lowBeam = _OscEnum("VehicleLightType", "lowBeam", min_minor_version=2)
    highBeam = _OscEnum("VehicleLightType", "highBeam", min_minor_version=2)
    fogLights = _OscEnum("VehicleLightType", "fogLights", min_minor_version=2)
    fogLightsFront = _OscEnum("VehicleLightType", "fogLightsFront", min_minor_version=2)
    fogLightsRear = _OscEnum("VehicleLightType", "fogLightsRear", min_minor_version=2)
    brakeLights = _OscEnum("VehicleLightType", "brakeLights", min_minor_version=2)
    warningLights = _OscEnum("VehicleLightType", "warningLights", min_minor_version=2)
    indicatorLeft = _OscEnum("VehicleLightType", "indicatorLeft", min_minor_version=2)
    indicatorRight = _OscEnum("VehicleLightType", "indicatorRight", min_minor_version=2)
    reversingLights = _OscEnum(
        "VehicleLightType", "reversingLights", min_minor_version=2
    )
    licensePlateIllumination = _OscEnum(
        "VehicleLightType", "licensePlateIllumination", min_minor_version=2
    )
    specialPurposeLights = _OscEnum(
        "VehicleLightType", "specialPurposeLights", min_minor_version=2
    )


class Role(metaclass=_EnumMeta):
    none = _OscEnum("Role", "none", min_minor_version=2)
    ambulance = _OscEnum("Role", "ambulance", min_minor_version=2)
    civil = _OscEnum("Role", "civil", min_minor_version=2)
    fire = _OscEnum("Role", "fire", min_minor_version=2)
    military = _OscEnum("Role", "military", min_minor_version=2)
    police = _OscEnum("Role", "police", min_minor_version=2)
    publicTransport = _OscEnum("Role", "publicTransport", min_minor_version=2)
    roadAssistance = _OscEnum("Role", "roadAssistance", min_minor_version=2)


class Wetness(metaclass=_EnumMeta):
    dry = _OscEnum("Wetness", "dry", min_minor_version=2)
    moist = _OscEnum("Wetness", "moist", min_minor_version=2)
    wetWithPuddles = _OscEnum("Wetness", "wetWithPuddles", min_minor_version=2)
    lowFlooded = _OscEnum("Wetness", "lowFlooded", min_minor_version=2)
    highFlooded = _OscEnum("Wetness", "highFlooded", min_minor_version=2)


class ColorType:
    other = _OscEnum("ColorType", "other", min_minor_version=2)
    red = _OscEnum("ColorType", "red", min_minor_version=2)
    yellow = _OscEnum("ColorType", "yellow", min_minor_version=2)
    green = _OscEnum("ColorType", "green", min_minor_version=2)
    blue = _OscEnum("ColorType", "blue", min_minor_version=2)
    violet = _OscEnum("ColorType", "violet", min_minor_version=2)
    orange = _OscEnum("ColorType", "orange", min_minor_version=2)
    brown = _OscEnum("ColorType", "brown", min_minor_version=2)
    black = _OscEnum("ColorType", "black", min_minor_version=2)
    grey = _OscEnum("ColorType", "grey", min_minor_version=2)
    white = _OscEnum("ColorType", "white", min_minor_version=2)

Classes

class AutomaticGearType

Expand source code

class AutomaticGearType(metaclass=_EnumMeta):
    n = _OscEnum("AutomaticGearType", "n", min_minor_version=2)
    p = _OscEnum("AutomaticGearType", "p", min_minor_version=2)
    r = _OscEnum("AutomaticGearType", "r", min_minor_version=2)
    d = _OscEnum("AutomaticGearType", "d", min_minor_version=2)

Class variables

var d

var n

var p

var r

class CloudState

Enum for CloudState

Expand source code

class CloudState(metaclass=_EnumMeta):
    """Enum for CloudState"""

    skyOff = _OscEnum("CloudState", "skyOff")
    free = _OscEnum("CloudState", "free")
    cloudy = _OscEnum("CloudState", "cloudy")
    overcast = _OscEnum("CloudState", "overcast")
    rainy = _OscEnum("CloudState", "rainy")

Class variables

var cloudy

var free

var overcast

var rainy

var skyOff

class ColorType

Expand source code

class ColorType:
    other = _OscEnum("ColorType", "other", min_minor_version=2)
    red = _OscEnum("ColorType", "red", min_minor_version=2)
    yellow = _OscEnum("ColorType", "yellow", min_minor_version=2)
    green = _OscEnum("ColorType", "green", min_minor_version=2)
    blue = _OscEnum("ColorType", "blue", min_minor_version=2)
    violet = _OscEnum("ColorType", "violet", min_minor_version=2)
    orange = _OscEnum("ColorType", "orange", min_minor_version=2)
    brown = _OscEnum("ColorType", "brown", min_minor_version=2)
    black = _OscEnum("ColorType", "black", min_minor_version=2)
    grey = _OscEnum("ColorType", "grey", min_minor_version=2)
    white = _OscEnum("ColorType", "white", min_minor_version=2)

Class variables

var black

var blue

var brown

var green

var grey

var orange

var other

var red

var violet

var white

var yellow

class ConditionEdge

Enum for ConditionEdge

Expand source code

class ConditionEdge(metaclass=_EnumMeta):
    """Enum for ConditionEdge"""

    rising = _OscEnum("ConditionEdge", "rising")
    falling = _OscEnum("ConditionEdge", "falling")
    risingOrFalling = _OscEnum("ConditionEdge", "risingOrFalling")
    none = _OscEnum("ConditionEdge", "none")

Class variables

var falling

var none

var rising

var risingOrFalling

class ControllerType

Expand source code

class ControllerType(metaclass=_EnumMeta):
    lateral = _OscEnum("ControllerType", "lateral", min_minor_version=2)
    longitudinal = _OscEnum("ControllerType", "longitudinal", min_minor_version=2)
    lighting = _OscEnum("ControllerType", "lighting", min_minor_version=2)
    animation = _OscEnum("ControllerType", "animation", min_minor_version=2)
    movement = _OscEnum("ControllerType", "movement", min_minor_version=2)
    appearance = _OscEnum("ControllerType", "appearance", min_minor_version=2)
    all = _OscEnum("ControllerType", "all", min_minor_version=2)

Class variables

var all

var animation

var appearance

var lateral

var lighting

var longitudinal

var movement

class CoordinateSystem

Enum for CoordinateSystem

Expand source code

class CoordinateSystem(metaclass=_EnumMeta):
    """Enum for CoordinateSystem"""

    entity = _OscEnum("CoordinateSystem", "entity", min_minor_version=1)
    lane = _OscEnum("CoordinateSystem", "lane", min_minor_version=1)
    road = _OscEnum("CoordinateSystem", "road", min_minor_version=1)
    trajectory = _OscEnum("CoordinateSystem", "trajectory", min_minor_version=1)

Class variables

var entity

var lane

var road

var trajectory

class DirectionalDimension

Expand source code

class DirectionalDimension(metaclass=_EnumMeta):
    longitudinal = _OscEnum("DirectionalDimension", "longitudinal", min_minor_version=2)
    lateral = _OscEnum("DirectionalDimension", "lateral", min_minor_version=2)
    vertical = _OscEnum("DirectionalDimension", "vertical", min_minor_version=2)

Class variables

var lateral

var longitudinal

var vertical

class DynamicsDimension

Enum for DynamicsDimension

Expand source code

class DynamicsDimension(metaclass=_EnumMeta):
    """Enum for DynamicsDimension"""

    rate = _OscEnum("DynamicsDimension", "rate")
    time = _OscEnum("DynamicsDimension", "time")
    distance = _OscEnum("DynamicsDimension", "distance")

Class variables

var distance

var rate

var time

class DynamicsShapes

Enum for DynamicsShapes

Expand source code

class DynamicsShapes(metaclass=_EnumMeta):
    """Enum for DynamicsShapes"""

    linear = _OscEnum("DynamicsShapes", "linear")
    cubic = _OscEnum("DynamicsShapes", "cubic")
    sinusoidal = _OscEnum("DynamicsShapes", "sinusoidal")
    step = _OscEnum("DynamicsShapes", "step")

Class variables

var cubic

var linear

var sinusoidal

var step

class FollowingMode

Enum for FollowingMode

Expand source code

class FollowingMode(metaclass=_EnumMeta):
    """Enum for FollowingMode"""

    position = _OscEnum("FollowingMode", "position")
    follow = _OscEnum("FollowingMode", "follow")

Class variables

var follow

var position

class FractionalCloudCover

Expand source code

class FractionalCloudCover(metaclass=_EnumMeta):
    zeroOktas = _OscEnum("FractionalCloudCover", "zeroOktas", min_minor_version=2)
    oneOktas = _OscEnum("FractionalCloudCover", "oneOktas", min_minor_version=2)
    twoOktas = _OscEnum("FractionalCloudCover", "twoOktas", min_minor_version=2)
    threeOktas = _OscEnum("FractionalCloudCover", "threeOktas", min_minor_version=2)
    fourOktas = _OscEnum("FractionalCloudCover", "fourOktas", min_minor_version=2)
    fiveOktas = _OscEnum("FractionalCloudCover", "fiveOktas", min_minor_version=2)
    sixOktas = _OscEnum("FractionalCloudCover", "sixOktas", min_minor_version=2)
    sevenOktas = _OscEnum("FractionalCloudCover", "sevenOktas", min_minor_version=2)
    eightOktas = _OscEnum("FractionalCloudCover", "eightOktas", min_minor_version=2)
    nineOktas = _OscEnum("FractionalCloudCover", "nineOktas", min_minor_version=2)

Class variables

var eightOktas

var fiveOktas

var fourOktas

var nineOktas

var oneOktas

var sevenOktas

var sixOktas

var threeOktas

var twoOktas

var zeroOktas

class LateralDisplacement

Expand source code

class LateralDisplacement(metaclass=_EnumMeta):
    any = _OscEnum("LateralDisplacement", "any", min_minor_version=1)
    leftToReferencedEntity = _OscEnum(
        "LateralDisplacement", "leftToReferencedEntity", min_minor_version=1
    )
    rightToReferencedEntity = _OscEnum(
        "LateralDisplacement", "rightToReferencedEntity", min_minor_version=1
    )

Class variables

var any

var leftToReferencedEntity

var rightToReferencedEntity

class LightMode

Expand source code

class LightMode(metaclass=_EnumMeta):
    on = _OscEnum("LightMode", "on", min_minor_version=2)
    off = _OscEnum("LightMode", "off", min_minor_version=2)
    flashing = _OscEnum("LightMode", "flashing", min_minor_version=2)

Class variables

var flashing

var off

var on

class LongitudinalDisplacement

Expand source code

class LongitudinalDisplacement(metaclass=_EnumMeta):
    any = _OscEnum("LongitudinalDisplacement", "any", min_minor_version=1)
    trailingReferencedEntity = _OscEnum(
        "LongitudinalDisplacement", "trailingReferencedEntity", min_minor_version=1
    )
    leadingReferencedEntity = _OscEnum(
        "LongitudinalDisplacement", "leadingReferencedEntity", min_minor_version=1
    )

Class variables

var any

var leadingReferencedEntity

var trailingReferencedEntity

class MiscObjectCategory

Enum for MiscObjectCategory

Expand source code

class MiscObjectCategory(metaclass=_EnumMeta):
    """Enum for MiscObjectCategory"""

    none = _OscEnum("MiscObjectCategory", "none")
    obstacle = _OscEnum("MiscObjectCategory", "obstacle")
    pole = _OscEnum("MiscObjectCategory", "pole")
    tree = _OscEnum("MiscObjectCategory", "tree")
    vegetation = _OscEnum("MiscObjectCategory", "vegetation")
    barrier = _OscEnum("MiscObjectCategory", "barrier")
    building = _OscEnum("MiscObjectCategory", "building")
    parkingSpace = _OscEnum("MiscObjectCategory", "parkingSpace")
    patch = _OscEnum("MiscObjectCategory", "patch")
    railing = _OscEnum("MiscObjectCategory", "railing")
    grafficIsland = _OscEnum("MiscObjectCategory", "grafficIsland")
    crosswalk = _OscEnum("MiscObjectCategory", "crosswalk")
    streetLamp = _OscEnum("MiscObjectCategory", "streetLamp")
    gantry = _OscEnum("MiscObjectCategory", "gantry")
    soundBarrier = _OscEnum("MiscObjectCategory", "soundBarrier")
    wind = _OscEnum("MiscObjectCategory", "wind", max_minor_version=0)
    roadMark = _OscEnum("MiscObjectCategory", "roadMark")

Class variables

var barrier

var building

var crosswalk

var gantry

var grafficIsland

var none

var obstacle

var parkingSpace

var patch

var pole

var railing

var roadMark

var soundBarrier

var streetLamp

var tree

var vegetation

var wind

class ObjectType

Enum for ObjectType

Expand source code

class ObjectType(metaclass=_EnumMeta):
    """Enum for ObjectType"""

    pedestrian = _OscEnum("ObjectType", "pedestrian")
    vehicle = _OscEnum("ObjectType", "vehicle")
    miscellaneous = _OscEnum("ObjectType", "miscellaneous")
    external = _OscEnum("ObjectType", "external", min_minor_version=1)

Class variables

var external

var miscellaneous

var pedestrian

var vehicle

class ParameterType

Enum for ParameterType

Expand source code

class ParameterType(metaclass=_EnumMeta):
    """Enum for ParameterType"""

    integer = _OscEnum(
        "ParameterType", "integer", max_minor_version=1, replacement="int"
    )
    int = _OscEnum("ParameterType", "int", min_minor_version=2)
    double = _OscEnum("ParameterType", "double")
    string = _OscEnum("ParameterType", "string")
    unsighedInt = _OscEnum("ParameterType", "unsighedInt")
    unsighedShort = _OscEnum("ParameterType", "unsighedShort")
    boolean = _OscEnum("ParameterType", "boolean")
    dateTime = _OscEnum("ParameterType", "dateTime")

Class variables

var boolean

var dateTime

var double

var int

var integer

var string

var unsighedInt

var unsighedShort

class PedestrianCategory

Enum for PedestrianCategory

Expand source code

class PedestrianCategory(metaclass=_EnumMeta):
    """Enum for PedestrianCategory"""

    pedestrian = _OscEnum("PedestrianCategory", "pedestrian")
    wheelchair = _OscEnum("PedestrianCategory", "wheelchair")
    animal = _OscEnum("PedestrianCategory", "animal")

Class variables

var animal

var pedestrian

var wheelchair

class PedestrianGestureType

Expand source code

class PedestrianGestureType(metaclass=_EnumMeta):
    phoneCallRightHand = _OscEnum(
        "PedestrianGestureType", "phoneCallRightHand", min_minor_version=2
    )
    phoneCallLeftHand = _OscEnum(
        "PedestrianGestureType", "phoneCallLeftHand", min_minor_version=2
    )
    phoneTextRightHand = _OscEnum(
        "PedestrianGestureType", "phoneTextRightHand", min_minor_version=2
    )
    phoneTextLeftHand = _OscEnum(
        "PedestrianGestureType", "phoneTextLeftHand", min_minor_version=2
    )
    wavingRightArm = _OscEnum(
        "PedestrianGestureType", "wavingRightArm", min_minor_version=2
    )
    wavingLeftArm = _OscEnum(
        "PedestrianGestureType", "wavingLeftArm", min_minor_version=2
    )
    umbrellaRightHand = _OscEnum(
        "PedestrianGestureType", "umbrellaRightHand", min_minor_version=2
    )
    umbrellaLeftHand = _OscEnum(
        "PedestrianGestureType", "umbrellaLeftHand", min_minor_version=2
    )
    crossArms = _OscEnum("PedestrianGestureType", "crossArms", min_minor_version=2)
    coffeeRightHand = _OscEnum(
        "PedestrianGestureType", "coffeeRightHand", min_minor_version=2
    )
    coffeeLeftHand = _OscEnum(
        "PedestrianGestureType", "coffeeLeftHand", min_minor_version=2
    )
    sandwichRightHand = _OscEnum(
        "PedestrianGestureType", "sandwichRightHand", min_minor_version=2
    )
    sandwichLeftHand = _OscEnum(
        "PedestrianGestureType", "sandwichLeftHand", min_minor_version=2
    )

Class variables

var coffeeLeftHand

var coffeeRightHand

var crossArms

var phoneCallLeftHand

var phoneCallRightHand

var phoneTextLeftHand

var phoneTextRightHand

var sandwichLeftHand

var sandwichRightHand

var umbrellaLeftHand

var umbrellaRightHand

var wavingLeftArm

var wavingRightArm

class PedestrianMotionType

Expand source code

class PedestrianMotionType(metaclass=_EnumMeta):
    standing = _OscEnum("PedestrianMotionType", "standing", min_minor_version=2)
    sitting = _OscEnum("PedestrianMotionType", "sitting", min_minor_version=2)
    lying = _OscEnum("PedestrianMotionType", "lying", min_minor_version=2)
    squatting = _OscEnum("PedestrianMotionType", "squatting", min_minor_version=2)
    walking = _OscEnum("PedestrianMotionType", "walking", min_minor_version=2)
    running = _OscEnum("PedestrianMotionType", "running", min_minor_version=2)
    reeling = _OscEnum("PedestrianMotionType", "reeling", min_minor_version=2)
    crawling = _OscEnum("PedestrianMotionType", "crawling", min_minor_version=2)
    cycling = _OscEnum("PedestrianMotionType", "cycling", min_minor_version=2)
    jumping = _OscEnum("PedestrianMotionType", "jumping", min_minor_version=2)
    ducking = _OscEnum("PedestrianMotionType", "ducking", min_minor_version=2)
    bendingDown = _OscEnum("PedestrianMotionType", "bendingDown", min_minor_version=2)

Class variables

var bendingDown

var crawling

var cycling

var ducking

var jumping

var lying

var reeling

var running

var sitting

var squatting

var standing

var walking

class PrecipitationType

Enum for PercipitationType

Expand source code

class PrecipitationType(metaclass=_EnumMeta):
    """Enum for PercipitationType"""

    dry = _OscEnum("PrecipitationType", "dry")
    rain = _OscEnum("PrecipitationType", "rain")
    snow = _OscEnum("PrecipitationType", "snow")

Class variables

var dry

var rain

var snow

class Priority

Enum for Priority

Expand source code

class Priority(metaclass=_EnumMeta):
    """Enum for Priority"""

    overwrite = _OscEnum(
        "Priority", "overwrite", max_minor_version=1, replacement="override"
    )
    override = _OscEnum("Priority", "override", min_minor_version=2)
    skip = _OscEnum("Priority", "skip")
    parallel = _OscEnum("Priority", "parallel")

Class variables

var override

var overwrite

var parallel

var skip

class ReferenceContext

Enum for ReferenceContext

Expand source code

class ReferenceContext(metaclass=_EnumMeta):
    """Enum for ReferenceContext"""

    relative = _OscEnum("ReferenceContext", "relative")
    absolute = _OscEnum("ReferenceContext", "absolute")

Class variables

var absolute

var relative

class RelativeDistanceType

Enum for RelativeDistanceType

Expand source code

class RelativeDistanceType(metaclass=_EnumMeta):
    """Enum for RelativeDistanceType"""

    longitudinal = _OscEnum("RelativeDistanceType", "longitudinal")
    lateral = _OscEnum("RelativeDistanceType", "lateral")
    cartesianDistance = _OscEnum(
        "RelativeDistanceType", "cartesianDistance", max_minor_version=0
    )
    euclidianDistance = _OscEnum(
        "RelativeDistanceType", "euclidianDistance", min_minor_version=1
    )

Class variables

var cartesianDistance

var euclidianDistance

var lateral

var longitudinal

class Role

Expand source code

class Role(metaclass=_EnumMeta):
    none = _OscEnum("Role", "none", min_minor_version=2)
    ambulance = _OscEnum("Role", "ambulance", min_minor_version=2)
    civil = _OscEnum("Role", "civil", min_minor_version=2)
    fire = _OscEnum("Role", "fire", min_minor_version=2)
    military = _OscEnum("Role", "military", min_minor_version=2)
    police = _OscEnum("Role", "police", min_minor_version=2)
    publicTransport = _OscEnum("Role", "publicTransport", min_minor_version=2)
    roadAssistance = _OscEnum("Role", "roadAssistance", min_minor_version=2)

Class variables

var ambulance

var civil

var fire

var military

var none

var police

var publicTransport

var roadAssistance

class RouteStrategy

Enum for RouteStrategy

Expand source code

class RouteStrategy(metaclass=_EnumMeta):
    """Enum for RouteStrategy"""

    fastest = _OscEnum("RouteStrategy", "fastest")
    shortest = _OscEnum("RouteStrategy", "shortest")
    leastIntersections = _OscEnum("RouteStrategy", "leastIntersections")
    random = _OscEnum("RouteStrategy", "random")

Class variables

var fastest

var leastIntersections

var random

var shortest

class RoutingAlgorithm

Expand source code

class RoutingAlgorithm(metaclass=_EnumMeta):
    assignedRoute = _OscEnum("RoutingAlgorithm", "assignedRoute", min_minor_version=2)
    fastest = _OscEnum("RoutingAlgorithm", "fastest", min_minor_version=2)
    leastIntersections = _OscEnum(
        "RoutingAlgorithm", "leastIntersections", min_minor_version=2
    )
    shortest = _OscEnum("RoutingAlgorithm", "shortest", min_minor_version=2)
    undefined = _OscEnum("RoutingAlgorithm", "undefined", min_minor_version=2)

Class variables

var assignedRoute

var fastest

var leastIntersections

var shortest

var undefined

class Rule

Enum for Rule

Expand source code

class Rule(metaclass=_EnumMeta):
    """Enum for Rule"""

    greaterThan = _OscEnum("Rule", "greaterThan")
    lessThan = _OscEnum("Rule", "lessThan")
    equalTo = _OscEnum("Rule", "equalTo")
    greaterOrEqual = _OscEnum("Rule", "greaterOrEqual", min_minor_version=1)
    lessOrEqual = _OscEnum("Rule", "lessOrEqual", min_minor_version=1)
    notEqualTo = _OscEnum("Rule", "notEqualTo", min_minor_version=1)

Class variables

var equalTo

var greaterOrEqual

var greaterThan

var lessOrEqual

var lessThan

var notEqualTo

class SpeedTargetValueType

Enum for SpeedTargetValueType

Expand source code

class SpeedTargetValueType(metaclass=_EnumMeta):
    """Enum for SpeedTargetValueType"""

    delta = _OscEnum("SpeedTargetValueType", "delta")
    factor = _OscEnum("SpeedTargetValueType", "factor")

Class variables

var delta

var factor

class StoryboardElementState

Enum for StoryboardElementState

Expand source code

class StoryboardElementState(metaclass=_EnumMeta):
    """Enum for StoryboardElementState"""

    startTransition = _OscEnum("StoryboardElementState", "startTransition")
    endTransition = _OscEnum("StoryboardElementState", "endTransition")
    stopTransition = _OscEnum("StoryboardElementState", "stopTransition")
    skipTransition = _OscEnum("StoryboardElementState", "skipTransition")
    completeState = _OscEnum("StoryboardElementState", "completeState")
    runningState = _OscEnum("StoryboardElementState", "runningState")
    standbyState = _OscEnum("StoryboardElementState", "standbyState")

Class variables

var completeState

var endTransition

var runningState

var skipTransition

var standbyState

var startTransition

var stopTransition

class StoryboardElementType

Enum for StoryboardElementType

Expand source code

class StoryboardElementType(metaclass=_EnumMeta):
    """Enum for StoryboardElementType"""

    story = _OscEnum("StoryboardElementType", "story")
    act = _OscEnum("StoryboardElementType", "act")
    maneuver = _OscEnum("StoryboardElementType", "maneuver")
    event = _OscEnum("StoryboardElementType", "event")
    action = _OscEnum("StoryboardElementType", "action")
    maneuverGroup = _OscEnum("StoryboardElementType", "maneuverGroup")

Class variables

var act

var action

var event

var maneuver

var maneuverGroup

var story

class TriggeringEntitiesRule

Enum for TriggeringEntitiesRule

Expand source code

class TriggeringEntitiesRule(metaclass=_EnumMeta):
    """Enum for TriggeringEntitiesRule"""

    any = _OscEnum("TriggeringEntitiesRule", "any")
    all = _OscEnum("TriggeringEntitiesRule", "all")

Class variables

var all

var any

class VehicleCategory

Enum for VehicleCategory

Expand source code

class VehicleCategory(metaclass=_EnumMeta):
    """Enum for VehicleCategory"""

    car = _OscEnum("VehicleCategory", "car")
    van = _OscEnum("VehicleCategory", "van")
    truck = _OscEnum("VehicleCategory", "truck")
    trailer = _OscEnum("VehicleCategory", "trailer")
    semitrailer = _OscEnum("VehicleCategory", "semitrailer")
    bus = _OscEnum("VehicleCategory", "bus")
    motorbike = _OscEnum("VehicleCategory", "motorbike")
    bicycle = _OscEnum("VehicleCategory", "bicycle")
    train = _OscEnum("VehicleCategory", "train")
    tram = _OscEnum("VehicleCategory", "tram")

Class variables

var bicycle

var bus

var car

var motorbike

var semitrailer

var trailer

var train

var tram

var truck

var van

class VehicleComponentType

Expand source code

class VehicleComponentType(metaclass=_EnumMeta):
    hood = _OscEnum("VehicleComponentType", "hood", min_minor_version=2)
    trunk = _OscEnum("VehicleComponentType", "trunk", min_minor_version=2)
    doorFrontRight = _OscEnum(
        "VehicleComponentType", "doorFrontRight", min_minor_version=2
    )
    doorFrontLeft = _OscEnum(
        "VehicleComponentType", "doorFrontLeft", min_minor_version=2
    )
    doorRearRight = _OscEnum(
        "VehicleComponentType", "doorRearRight", min_minor_version=2
    )
    doorRearLeft = _OscEnum("VehicleComponentType", "doorRearLeft", min_minor_version=2)
    windowFrontRight = _OscEnum(
        "VehicleComponentType", "windowFrontRight", min_minor_version=2
    )
    windowFrontLeft = _OscEnum(
        "VehicleComponentType", "windowFrontLeft", min_minor_version=2
    )
    windowRearRight = _OscEnum(
        "VehicleComponentType", "windowRearRight", min_minor_version=2
    )
    windowRearLeft = _OscEnum(
        "VehicleComponentType", "windowRearLeft", min_minor_version=2
    )
    sideMirrors = _OscEnum("VehicleComponentType", "sideMirrors", min_minor_version=2)
    sideMirrorRight = _OscEnum(
        "VehicleComponentType", "sideMirrorRight", min_minor_version=2
    )
    sideMirrorLeft = _OscEnum(
        "VehicleComponentType", "sideMirrorLeft", min_minor_version=2
    )

Class variables

var doorFrontLeft

var doorFrontRight

var doorRearLeft

var doorRearRight

var hood

var sideMirrorLeft

var sideMirrorRight

var sideMirrors

var trunk

var windowFrontLeft

var windowFrontRight

var windowRearLeft

var windowRearRight

class VehicleLightType

Expand source code

class VehicleLightType(metaclass=_EnumMeta):
    daytimeRunningLights = _OscEnum(
        "VehicleLightType", "daytimeRunningLights", min_minor_version=2
    )
    lowBeam = _OscEnum("VehicleLightType", "lowBeam", min_minor_version=2)
    highBeam = _OscEnum("VehicleLightType", "highBeam", min_minor_version=2)
    fogLights = _OscEnum("VehicleLightType", "fogLights", min_minor_version=2)
    fogLightsFront = _OscEnum("VehicleLightType", "fogLightsFront", min_minor_version=2)
    fogLightsRear = _OscEnum("VehicleLightType", "fogLightsRear", min_minor_version=2)
    brakeLights = _OscEnum("VehicleLightType", "brakeLights", min_minor_version=2)
    warningLights = _OscEnum("VehicleLightType", "warningLights", min_minor_version=2)
    indicatorLeft = _OscEnum("VehicleLightType", "indicatorLeft", min_minor_version=2)
    indicatorRight = _OscEnum("VehicleLightType", "indicatorRight", min_minor_version=2)
    reversingLights = _OscEnum(
        "VehicleLightType", "reversingLights", min_minor_version=2
    )
    licensePlateIllumination = _OscEnum(
        "VehicleLightType", "licensePlateIllumination", min_minor_version=2
    )
    specialPurposeLights = _OscEnum(
        "VehicleLightType", "specialPurposeLights", min_minor_version=2
    )

Class variables

var brakeLights

var daytimeRunningLights

var fogLights

var fogLightsFront

var fogLightsRear

var highBeam

var indicatorLeft

var indicatorRight

var licensePlateIllumination

var lowBeam

var reversingLights

var specialPurposeLights

var warningLights

class VersionBase

base class for checking different versions of OpenSCENARIO

Expand source code

class VersionBase:
    """base class for checking different versions of OpenSCENARIO"""

    version_major = 1
    version_minor = _MINOR_VERSION

    def isVersion(self, major=1, minor=_MINOR_VERSION):
        return major == self.version_major and minor == self.version_minor

    def isVersionEqLess(self, major=1, minor=_MINOR_VERSION):
        return major >= self.version_major and minor >= self.version_minor

    def isVersionEqLarger(self, major=1, minor=_MINOR_VERSION):
        return major <= self.version_major and minor <= self.version_minor

    def setVersion(self, major=1, minor=_MINOR_VERSION):
        VersionBase.version_major = major
        VersionBase.version_minor = minor

Subclasses

• scenariogeneration.xosc.actions._Action
• scenariogeneration.xosc.actions._ActionType
• Axle
• Axles
• Entities
• Entity
• ExternalObjectReference
• ScenarioObject
• scenariogeneration.xosc.enumerations._OscEnum
• Deterministic
• DeterministicMultiParameterDistribution
• DistributionRange
• DistributionSet
• ParameterValueDistribution
• ParameterValueSet
• Range
• Stochastic
• scenariogeneration.xosc.parameters._HistogramBin
• scenariogeneration.xosc.parameters._ProbabilityDistributionSetElement
• Clothoid
• ControlPoint
• Nurbs
• Polyline
• Waypoint
• RoadNetwork
• Scenario
• Act
• Event
• Init
• ManeuverGroup
• Story
• StoryBoard
• scenariogeneration.xosc.storyboard._Actors
• TriggeringEntities
• AbsoluteSpeed
• BoundingBox
• Catalog
• CatalogFile
• CatalogReference
• Center
• Color
• Dimensions
• DirectionOfTravelDistribution
• DynamicsConstraints
• EntityRef
• FileHeader
• Fog
• License
• Orientation
• Parameter
• ParameterAssignment
• ParameterDeclarations
• Phase
• Precipitation
• Properties
• RelativeSpeedToMaster
• RoadCondition
• Sun
• TargetDistanceSteadyState
• TargetTimeSteadyState
• TimeOfDay
• TimeReference
• TrafficDefinition
• TrafficSignalController
• TransitionDynamics
• UserDefinedLight
• ValueConstraint
• ValueConstraintGroup
• Variable
• VariableDeclarations
• Weather
• Wind
• scenariogeneration.xosc.utils._AnimationType
• scenariogeneration.xosc.utils._BaseCatalog
• scenariogeneration.xosc.utils._ColorDefinition
• scenariogeneration.xosc.utils._EntityTriggerType
• scenariogeneration.xosc.utils._LightState
• scenariogeneration.xosc.utils._PositionType
• scenariogeneration.xosc.utils._StochasticDistributionType
• scenariogeneration.xosc.utils._TrafficSignalState
• scenariogeneration.xosc.utils._TriggerType
• scenariogeneration.xosc.utils._ValueTriggerType
• scenariogeneration.xosc.utils._VehicleComponent

Class variables

var version_major

var version_minor

Methods

def isVersion(self, major=1, minor=2)

Expand source code

def isVersion(self, major=1, minor=_MINOR_VERSION):
    return major == self.version_major and minor == self.version_minor

def isVersionEqLarger(self, major=1, minor=2)

Expand source code

def isVersionEqLarger(self, major=1, minor=_MINOR_VERSION):
    return major <= self.version_major and minor <= self.version_minor

def isVersionEqLess(self, major=1, minor=2)

Expand source code

def isVersionEqLess(self, major=1, minor=_MINOR_VERSION):
    return major >= self.version_major and minor >= self.version_minor

def setVersion(self, major=1, minor=2)

Expand source code

def setVersion(self, major=1, minor=_MINOR_VERSION):
    VersionBase.version_major = major
    VersionBase.version_minor = minor

class Wetness

Expand source code

class Wetness(metaclass=_EnumMeta):
    dry = _OscEnum("Wetness", "dry", min_minor_version=2)
    moist = _OscEnum("Wetness", "moist", min_minor_version=2)
    wetWithPuddles = _OscEnum("Wetness", "wetWithPuddles", min_minor_version=2)
    lowFlooded = _OscEnum("Wetness", "lowFlooded", min_minor_version=2)
    highFlooded = _OscEnum("Wetness", "highFlooded", min_minor_version=2)

Class variables

var dry

var highFlooded

var lowFlooded

var moist

var wetWithPuddles