SBUUID#

samson.SBUUID objects can hold Universally Unique IDs (UUIDs), which are used to identify classes and SAMSON Extensions.

See also

SAMSON SDK: SBCContainerUUID

class samson.SBUUID(*args, **kwargs)#

Bases: pybind11_object

This class describes a universally unique identifier (UUID).

This class objects can hold Universally Unique IDs (UUIDs), which are used to identify classes and SAMSON Extensions (Elements).

Overloaded function.

  1. __init__(self: samson.SBUUID, uuid: str) -> None

Constructs a UUID from a string.

Parameters:

uuid (str) – A valid UUID string.

Examples

Create a UUID object from a string:

>>> uuid = SBUUID('BE5DA3CC-70F7-4963-8B08-2B72BE5A6790')
>>> print(uuid)
BE5DA3CC-70F7-4963-8B08-2B72BE5A6790

Notes

SAMSON provides the UUID Generator extension which you can use to generate new UUIDs.

  1. __init__(self: samson.SBUUID, uuid: samson.SBUUID) -> None

Copy constructor.

Parameters:

uuid (samson.SBUUID) – UUID to copy.

  1. __init__(self: samson.SBUUID) -> None

Constructs an invalid UUID

__eq__(self: samson.SBUUID, arg0: samson.SBUUID) → bool#

Returns True when two UUIDs are equal.

__lt__(self: samson.SBUUID, arg0: samson.SBUUID) → bool#

Lexicographic comparison with another UUID.

__ne__(self: samson.SBUUID, arg0: samson.SBUUID) → bool#

Returns True when two UUIDs are different.

decrement(self: samson.SBUUID) → samson.SBUUID#

Prefix decrement (lexicographic, in place).

increment(self: samson.SBUUID) → samson.SBUUID#

Prefix increment (lexicographic, in place).

postDecrement(self: samson.SBUUID) → samson.SBUUID#

Postfix decrement (returns previous value).

postIncrement(self: samson.SBUUID) → samson.SBUUID#

Postfix increment (returns previous value).

invalid = SBUUID("00000000-0000-0000-0000-000000000000")#
property isValid#

Returns True if and only if the UUID is valid. .. rubric:: Examples

Create a UUID object from a string:

>>> uuid = SBUUID('BE5DA3CC-70F7-4963-8B08-2B72BE5A6790')
>>> print(uuid.isValid)
True