comms.repository.RuntimeRepoControl.BatchRequest Class Reference

A class representing a batch of individual datapoint requests to be sent to the repository adapter for handling. More...

Inheritance diagram for comms.repository.RuntimeRepoControl.BatchRequest:

Public Member Functions
	__init__ (self)
	subscribe (self, Optional[DataPointPath] path=None, Optional[Any] tag=None)
	Add a request to subscribe to datapoint creation/deletion events or to value updates for a particular datapoint.
	unsubscribe (self, RepositorySubscriberIf.SubscriptionId id, Optional[Any] tag=None)
	Add a request to unsubscribe from a previous subscription request.
Public Member Functions inherited from comms.repository.RepositoryControl.BatchRequest
	__init__ (self)
	get_children (self, DataPointPath path, bool recurse=False, Optional[Any] tag=None)
	Add a request to get children for a particular datapoint path.
	data_point_exists (self, DataPointPath path, Optional[Any] tag=None)
	Add a request to check if a datapoint path exists.
	create_data_point (self, DataPointPath path, Any initial_value, Optional[Mapping[str, Any]] metadata=None, Optional[Any] tag=None)
	Add a request to create a new datapoint.
	delete_data_point (self, DataPointPath path, Optional[Any] tag=None)
	Add a request to delete an existing datapoint.
	read_meta_data (self, DataPointPath path, Optional[Any] tag=None)
	Add a request to read the metadata for a datapoint.
	write_meta_data (self, DataPointPath path, Optional[Mapping[str, Any]] metadata=None, Optional[Any] tag=None)
	Add a request to write new metadata for a datapoint.
	read_data_point (self, DataPointPath path, Any buffer, Optional[Mapping[str, Any]] metadata=None, Optional[Any] tag=None)
	Add a request to read a datapoint.
	write_data_point (self, DataPointPath path, Any buffer, Optional[Mapping[str, Any]] metadata=None, Optional[Any] tag=None)
	Add a request to write a datapoint.
	partial_read_data_point (self, DataPointPath path, Any buffer, int first, int last, int d_first, Optional[Mapping[str, Any]] metadata=None, Optional[Any] tag=None)
	Add a request to partially read a datapoint.
	partial_write_data_point (self, DataPointPath path, Any buffer, int first, int last, int d_first, Optional[Mapping[str, Any]] metadata=None, Optional[Any] tag=None)
	Add a request to partially write a datapoint.
	create_symlink (self, DataPointPath dp, DataPointPath link, Optional[Any] tag=None)
	Add a request to create a symlink.
	update_symlink (self, DataPointPath dp, DataPointPath link, Optional[Any] tag=None)
	Add a request to update a symlink.

Additional Inherited Members
Protected Attributes inherited from comms.repository.RepositoryControl.BatchRequest
list	_requests = []

Detailed Description

A class representing a batch of individual datapoint requests to be sent to the repository adapter for handling.

This extends the RepositoryControl.BatchRequest class with datapoint subscribe and unsubscribe requests.

Constructor & Destructor Documentation

__init__()

comms.repository.RuntimeRepoControl.BatchRequest.__init__

(

self

)

Member Function Documentation

subscribe()

comms.repository.RuntimeRepoControl.BatchRequest.subscribe	(		self,
		Optional[DataPointPath]	path = None,
		Optional[Any]	tag = None )

Add a request to subscribe to datapoint creation/deletion events or to value updates for a particular datapoint.

If path is given then that particular datapoint is subscribed to for value updates. Otherwise the request will subscribe to structural change events (create/delete).

unsubscribe()

comms.repository.RuntimeRepoControl.BatchRequest.unsubscribe	(		self,
		RepositorySubscriberIf.SubscriptionId	id,
		Optional[Any]	tag = None )

Add a request to unsubscribe from a previous subscription request.

---

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

• clients/configTool/src/rtctk/configtool/comms/repository.py