gui.repository_model._FetchCompletion Class Reference

Classes
class	_Context
	This class holds objects that need to be tracked across the request completion handlers. More...

Public Member Functions
	__init__ (self, TreeNode node, _FetchCompletion._Context context)
	create_buffer_object (self, type)
	Create an object to use as a buffer via Python buffer protocol that will be passed to the underlying repository API for receiving data.
	get_children_complete (self, path, dppaths, subpaths)
	Request completion handler for get_children requests.
	get_children_failed (self, path, exception)
	Request completion handler for failed get_children requests, which resets the corresponding internal state variables.
	read_meta_data_complete (self, path, metadata)
	Request completion handler for read_meta_data requests, which will update the internal tree node with the retrieved metadata.
	read_meta_data_failed (self, path, exception)
	Request completion handler for failed read_meta_data requests, which resets the corresponding internal state variables for the node's metadata and value.
	read_data_point_complete (self, path)
	Request completion handler for read_data_point requests, which checks if the fetch operation was cancelled, in which case the data is marked as stale.
	read_data_point_failed (self, path, exception)
	Request completion handler for failed read_data_point requests, which resets the corresponding internal state variables for the node's value.
	data_point_updated (self, path, value)
	This request completion handler will update the internal tree node with the retrieved data value.

Public Attributes
	node = node
	context = context

Static Protected Attributes
dict	_buffer_object_constructor_map

Constructor & Destructor Documentation

__init__()

gui.repository_model._FetchCompletion.__init__	(		self,
		TreeNode	node,
		_FetchCompletion._Context	context )

Member Function Documentation

create_buffer_object()

gui.repository_model._FetchCompletion.create_buffer_object	(		self,
			type )

Create an object to use as a buffer via Python buffer protocol that will be passed to the underlying repository API for receiving data.

The type given must correspond to one of the types supported by RepositoryIf, i.e. as is used with RepositoryIf.create_data_point.

data_point_updated()

gui.repository_model._FetchCompletion.data_point_updated	(		self,
			path,
			value )

This request completion handler will update the internal tree node with the retrieved data value.

This is called by the read_data_point request. Appropriate signals are emitted to the view widgets to indicate the data value was updated.

get_children_complete()

gui.repository_model._FetchCompletion.get_children_complete	(		self,
			path,
			dppaths,
			subpaths )

Request completion handler for get_children requests.

This will update the internal tree node with new children and initiate a request to fetch metadata for the new children and additionally request their children, but stop recursion at that point, i.e. do not fetch grandchildren. Appropriate signals are sent to the view widgets to indicate data updates.

get_children_failed()

gui.repository_model._FetchCompletion.get_children_failed	(		self,
			path,
			exception )

Request completion handler for failed get_children requests, which resets the corresponding internal state variables.

read_data_point_complete()

gui.repository_model._FetchCompletion.read_data_point_complete	(		self,
			path )

Request completion handler for read_data_point requests, which checks if the fetch operation was cancelled, in which case the data is marked as stale.

read_data_point_failed()

gui.repository_model._FetchCompletion.read_data_point_failed	(		self,
			path,
			exception )

Request completion handler for failed read_data_point requests, which resets the corresponding internal state variables for the node's value.

read_meta_data_complete()

gui.repository_model._FetchCompletion.read_meta_data_complete	(		self,
			path,
			metadata )

Request completion handler for read_meta_data requests, which will update the internal tree node with the retrieved metadata.

Once all metadata for all children that were requested in the same fetch context has been received, this will initiate a request to fetch the actual datapoint values. Appropriate signals are emitted to the view widgets to indicate the metadata was updated.

read_meta_data_failed()

gui.repository_model._FetchCompletion.read_meta_data_failed	(		self,
			path,
			exception )

Request completion handler for failed read_meta_data requests, which resets the corresponding internal state variables for the node's metadata and value.

Both are reset, since neither will be able to be updated if the metadata request fails.

Member Data Documentation

_buffer_object_constructor_map

gui.repository_model._FetchCompletion._buffer_object_constructor_map

staticprotected

context

gui.repository_model._FetchCompletion.context = context

node

gui.repository_model._FetchCompletion.node = node

---

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

• clients/configTool/src/rtctk/configtool/gui/repository_model.py