maxon.Id

Description

maxon.Id represents an identifier consisting of a c-string.

Such identifiers are used mainly to identify entities such as interfaces, components, classes, registries, entries, modules or published objects.

Inheritance diagram

Inheritance

Parent Class:

• maxon.Builtin

Methods Signature

__add__(other)	Returns a new string by adding other string representation to the current string value.
__eq__(other)	Checks if other string value is equal to the current value`.
__init__([C])	Initializes an maxon.Id with the passed data, if a maxon.Data is passed a copy is done.
__iter__()	Iterates the string representation.
__len__()	Returns the string length of the maxon.Id.
__ne__(other)	Checks if other string value is unequal to the current value`.
__radd__(other)	Returns a new string by adding other string representation to the current string value.
__repr__()	Returns the string representation of an maxon.Id.
__str__()	Returns the string representation of an maxon.Id.

Methods Definition

Id.__add__(other)

Returns a new string by adding other string representation to the current string value.

Parameters

other (Union[str, maxon.Id, maxon.InternedId]) – The other string value to add to the current id.

Returns

The new concatenated string.

Return type

str

Id.__eq__(other)

Checks if other string value is equal to the current value`.

Parameters

other (Union[str, maxon.String maxon.Id, maxon.InternedId]) – The other identifier to compare.

Returns

True if other is equal to the current value, otherwise False.

Return type

bool

Id.__init__(C=None)

Initializes an maxon.Id with the passed data, if a maxon.Data is passed a copy is done.

Parameters

C (Optional[maxon.Data]) – The input data to derive the maxon.Id.

Id.__iter__()

Iterates the string representation.

Id.__len__()

Returns the string length of the maxon.Id.

Returns

String length of the current maxon.Id.

Return type

int

Id.__ne__(other)

Checks if other string value is unequal to the current value`.

Parameters

other (Union[str, maxon.String maxon.Id, maxon.InternedId]) – The other identifier to compare.

Returns

True if other is unequal to the current value, otherwise False.

Return type

bool

Id.__radd__(other)

Returns a new string by adding other string representation to the current string value.

Parameters

other (Union[str, maxon.Id, maxon.InternedId]) – The other string value to add to the current id.

Returns

The new concatenated string.

Return type

str

Id.__repr__()

Returns the string representation of an maxon.Id.

Return type

str

Id.__str__()

Returns the string representation of an maxon.Id.

Return type

str