RTC Toolkit 6.0.0
Loading...
Searching...
No Matches
gui.runtime_repo_model.RuntimeRepoModel Class Reference

An implementation of a Qt model object for the Runtime Configuration Repository. More...

Inheritance diagram for gui.runtime_repo_model.RuntimeRepoModel:

Classes

class  _DataUpdateCompletion
 This class behaves like a closure, holding the tree node to update in the model. More...
 

Public Member Functions

 __init__ (self, RuntimeRepoControl repo, *args, **kwargs)
 
 subscribe (self, Sequence[QModelIndex] indices)
 Subscribes to the datapoints indicated by the model indices.
 
 unsubscribe (self, Sequence[QModelIndex] indices)
 Unsubscribes from datapoint updates for all of the model indices provided.
 

Detailed Description

An implementation of a Qt model object for the Runtime Configuration Repository.

Data is lazy loaded and cached such that only the parts of the data that GUI view widgets actually request is fetched. It is also possible to subscribe to datapoint update notifications, which will cause the model to automatically update the cached model data and generate appropriate update signals to Qt view widgets.

Constructor & Destructor Documentation

◆ __init__()

gui.runtime_repo_model.RuntimeRepoModel.__init__ ( self,
RuntimeRepoControl repo,
* args,
** kwargs )

Member Function Documentation

◆ subscribe()

gui.runtime_repo_model.RuntimeRepoModel.subscribe ( self,
Sequence[QModelIndex] indices )

Subscribes to the datapoints indicated by the model indices.

Note that if an index is not valid or does not correspond to an actual datapoint then it is silently ignored. It is expected that the caller passes correct indices. This is similar to how setData behaves.

◆ unsubscribe()

gui.runtime_repo_model.RuntimeRepoModel.unsubscribe ( self,
Sequence[QModelIndex] indices )

Unsubscribes from datapoint updates for all of the model indices provided.

If an index is not valid or does not correspond to an actual datapoint then this is silently ignored, to mirror how the subscribe method behaves.


The documentation for this class was generated from the following file: