maxon.DataDescriptionInterface

Description

Inheritance diagram

Inheritance

Child Class:

• maxon.DataDescription

Methods Signature

Compare(other)	Compares the 2 values.
DescribeIO(*args)	Describes all elements of this class for I/O operations.
EraseEntry(id)	Deletes a attribute from the description.
GetEntries()	Returns a array with all entries.
GetEntry(id)	Returns a specific entry with the given id.
GetEntryCount()	Returns the number of entries in the description.
GetHashCode()	Returns the hashcode of the description.
GetInfo()	Returns the info dictionary.
IsEqual(other, equality)	Compares two descriptions.
Reset()	Resets the description and clear all attributes.
SetEntry(props[, merge])	SetEntry description.
SetInfo(info)	The info dictionary of the description.
ToString()	Returns a readable string of the content.

Methods Definition

DataDescriptionInterface.Compare(other)

Compares the 2 values.

Parameters

other (maxon.DataDescriptionInterface) – Other description to compare.

static DataDescriptionInterface.DescribeIO(*args)

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

Parameters

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

DataDescriptionInterface.EraseEntry(id)

Deletes a attribute from the description.

Parameters

id (maxon.InternedId) – maxon.Id of the attribute to delete.

DataDescriptionInterface.GetEntries()

Returns a array with all entries.

Returns

A array with all entries.

Return type

maxon.BaseArray [maxon.DataDictionary]

DataDescriptionInterface.GetEntry(id)

Returns a specific entry with the given id.

Parameters

id (maxon.Id) – Id to find.

Returns

DataDictionary on success. Error if the requested attribute was not in the description-

Return type

maxon.DataDictionary

DataDescriptionInterface.GetEntryCount()

Returns the number of entries in the description.

Returns

The number of entries in the description.

Return type

int

DataDescriptionInterface.GetHashCode()

Returns the hashcode of the description.

Returns

The hashcode.

Return type

int

DataDescriptionInterface.GetInfo()

Returns the info dictionary.

Returns

The info dictionary.

Return type

maxon.DataDictionary.

DataDescriptionInterface.IsEqual(other, equality)

Compares two descriptions.

Parameters

• other (maxon.DataDescriptionInterface) – Other description to compare.

• equality (maxon.EQUALITY) – See @EQUALITY.

Returns

True in equality.

Return type

bool

DataDescriptionInterface.Reset()

Resets the description and clear all attributes.

DataDescriptionInterface.SetEntry(props, merge=False)

SetEntry description.

Parameters

• props (maxon.DataDictionary) – Properties to set. The DESCRIPTION.BASE.IDENTIFIER will be used as key for the hashmap.

• merge (bool) – True if the container should be merged with the existing props im the description. The given props will have priority over the existing.

Returns

True if properties has been changed.

Return type

bool

DataDescriptionInterface.SetInfo(info)

The info dictionary of the description.

Parameters

info (maxon.DataDictionary) – Dictionary with infos.

DataDescriptionInterface.ToString()

Returns a readable string of the content.

Returns

A readable string of the content.

Return type

str