comms.repository.RepositoryControl.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.RepositoryControl.BatchRequest:

Public Member Functions
	__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.

Protected Attributes
list	_requests = []

Detailed Description

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

Constructor & Destructor Documentation

__init__()

comms.repository.RepositoryControl.BatchRequest.__init__

(

self

)

Member Function Documentation

create_data_point()

comms.repository.RepositoryControl.BatchRequest.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.

create_symlink()

comms.repository.RepositoryControl.BatchRequest.create_symlink	(		self,
		DataPointPath	dp,
		DataPointPath	link,
		Optional[Any]	tag = None )

Add a request to create a symlink.

data_point_exists()

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

Add a request to check if a datapoint path exists.

delete_data_point()

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

Add a request to delete an existing datapoint.

get_children()

comms.repository.RepositoryControl.BatchRequest.get_children	(		self,
		DataPointPath	path,
		bool	recurse = False,
		Optional[Any]	tag = None )

Add a request to get children for a particular datapoint path.

partial_read_data_point()

comms.repository.RepositoryControl.BatchRequest.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()

comms.repository.RepositoryControl.BatchRequest.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.

read_data_point()

comms.repository.RepositoryControl.BatchRequest.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.

read_meta_data()

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

Add a request to read the metadata for a datapoint.

update_symlink()

comms.repository.RepositoryControl.BatchRequest.update_symlink	(		self,
		DataPointPath	dp,
		DataPointPath	link,
		Optional[Any]	tag = None )

Add a request to update a symlink.

write_data_point()

comms.repository.RepositoryControl.BatchRequest.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.

write_meta_data()

comms.repository.RepositoryControl.BatchRequest.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.

Member Data Documentation

_requests

list comms.repository.RepositoryControl.BatchRequest._requests = []

protected

---

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

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