maxon.RegistryInterface¶
Description¶
maxon.RegistryInterface
is used internally by maxon.Registry
.
Warning
Methods Signature¶
CreateIterator (reg) |
Returns an iterator over all entries registered at this registry. |
EraseEntry (registry, eid) |
Removes the entry identified by eid from registry. |
Find (id) |
Returns the registry entry registered at this registry under the given identifier |
FindEntryValue (registry, eid) |
Returns the registry entry registered at the passed registry under the given identifier |
GetId () |
Returns the maxon.Id . |
GetStamp () |
Returns the registry stamp. |
InsertEntry (registry, eid, value) |
Registers an entry at the registry under the given identifier. |
Methods Definition¶
-
static
RegistryInterface.
CreateIterator
(reg)¶ Returns an iterator over all entries registered at this registry.
Parameters: reg ( maxon.Registry
) – The registry.Returns: An iterator.
-
static
RegistryInterface.
EraseEntry
(registry, eid)¶ Removes the entry identified by eid from registry.
Note
If no such entry exists, nothing happens.
Parameters: - registry (
maxon.Registry
) – The registry to add the data. - eid (
maxon.Id
) – Identifier within this registry.
- registry (
-
static
RegistryInterface.
Find
(id)¶ Returns the registry entry registered at this registry under the given identifier
Note
If no entry exists for the given identifier, None is returned.
Parameters: - id – Identifier within this registry.
- id –
maxon.Id
Returns: The value stored in the registry.
Return type: Any
-
static
RegistryInterface.
FindEntryValue
(registry, eid)¶ Returns the registry entry registered at the passed registry under the given identifier
Parameters: - registry (
maxon.Registry
) – The registry to find the value from. - eid (
maxon.Id
) – Identifier within this registry.
Returns: The value stored in the registry.
Return type: Any
- registry (
-
RegistryInterface.
GetStamp
()¶ Returns the registry stamp.
Returns: The registry stamp. Return type: int
-
static
RegistryInterface.
InsertEntry
(registry, eid, value)¶ Registers an entry at the registry under the given identifier.
Note
If an entry already exists for the identifier, nothing happens, and an error is raised.
Parameters: - registry (
maxon.Registry
) – The registry to add the data. - eid (
maxon.Id
) – Identifier within this registry. - value (
maxon.Data
) – Value to register.
- registry (