maxon.UuidInterface¶

Description¶

Inheritance diagram¶

Inheritance

Child Class:

maxon.Uuid

Methods Signature¶

`Alloc`([obj])	Create a new Uuid.
`AllocEmpty`()	Return a new Uuid.
`AllocFromString`(uuidStr)	Create a new Uuid based on a string representing a valid Uuid.
`AllocFromUuid`(uuid)	Return a copy of the passed Uuid.
`Compare`()	Compares the uuid against another uuid.
`CreateId`()	Creates a new uuid.
`CreateUuidString`()	Creates a new uuid and returns the string of it.
`DescribeIO`(stream)	Describes all elements of this class for I/O operations.
`GetHashCode`()	Returns the hash code of the uuid.
`IsEmpty`()	Returns whether the object is empty or not.
`IsPopulated`()	Returns whether the object is populated or not.
`Set`(uuid)	Sets a given uuid string.
`ToString`()	Converts the uuid into a string.

Methods Definition¶

static UuidInterface.Alloc(obj=None)¶

Create a new Uuid.

Parameters: uuid (Union[None, SourceLocation, String, str, Uuid]) – None if a totally new Uuid should be returned otherwise a copy will be performed.
Return type: maxon.Uuid
Returns: The newly created Uuid.

static UuidInterface.AllocEmpty()¶

Return a new Uuid.

Return type: maxon.Uuid
Returns: The newly created Uuid.

static UuidInterface.AllocFromString(uuidStr)¶

Create a new Uuid based on a string representing a valid Uuid.

Parameters: uuid (str) – The sting to copy to an Uuid.
Return type: maxon.Uuid
Returns: The newly created Uuid.

static UuidInterface.AllocFromUuid(uuid)¶

Return a copy of the passed Uuid.

Parameters: uuid (maxon.Uuid) – The uuid to copy.
Return type: maxon.Uuid
Returns: The newly created Uuid.

UuidInterface.Compare()¶

Compares the uuid against another uuid.

Parameters: uuid (maxon.Uuid) – The uuid to compare with.
Return type: maxon.COMPARERESULT
Returns: See COMPARERESULT.

UuidInterface.CreateId()¶

Creates a new uuid.

Return type: maxon.Uuid
Returns: The newly created Uuid.

static UuidInterface.CreateUuidString()¶

Creates a new uuid and returns the string of it.

Return type: maxon.Uuid
Returns: The newly created Uuid.

static UuidInterface.DescribeIO(stream)¶

Describes all elements of this class for I/O operations.

Parameters: stream (maxon.DataSerializeInterface) – The stream that is used to register the class members.

UuidInterface.GetHashCode()¶

Returns the hash code of the uuid.

Note

The return value is 0 if the object IsEmpty().

Return type: int

UuidInterface.IsEmpty()¶

Returns whether the object is empty or not.

A Uuid is empty if it hasn’t been constructed yet, or if a copy operation on the object failed, or if it just contains 0-values.

Returns: Returns whether the object is empty or not.
Return type: bool

UuidInterface.IsPopulated()¶

Returns whether the object is populated or not.

Always the opposite of IsEmpty().

Returns: Returns whether the object is populated or not.
Return type: bool

UuidInterface.Set(uuid)¶

Sets a given uuid string. The id must be of the format “00000000-0000-0000-0000-000000000000”.

Parameters: uuid (Union[str, StringInterface]) – String with a valid uuid.
Raises: IllegalArgumentError – if the id could not be parsed.

UuidInterface.ToString()¶

Converts the uuid into a string.

The format will be “00000000-0000-0000-0000-000000000000” and the letters will be uppercase.

Returns: String representation of the uuid.
Return type: str