cli.operations.Operations Class Reference

Public Member Functions
def	__init__ (self, config)
def	get_repository (self, str repo)
	Return the appropriate repository adapter based on the value of the repo option string. More...
def	run_shell (self, str repo_name)
	Setup the repository object and enter a Python shell for interactive mode. More...
def	list_datapoints (self, str repo_name, path, bool recursive)
	List all available datapoints and sub-paths found under a given path. More...
def	get_datapoint (self, str repo_name, DataPointPath path, bool get_type, bool get_size)
	Get and print the datapoint value to console. More...
def	parse_value (self, str value, Optional[Any] requested_type=None)
def	set_datapoint (self, str repo_name, DataPointPath path, str value, requested_type)
	Set a datapoint's value. More...
def	read_hierarchy (self, str repo_name, DataPointPath path, str output_path)
def	write_hierarchy (self, str repo_name, DataPointPath path, str input_path)
def	delete_datapoints (self, str repo_name, DataPointPath path, bool recursive)
	Deletes a single datapoint or a whole hierarchy if recursive is set to True. More...
def	init_repository_metadata (self)
	Initialise the metadata for RTC Toolkit types in CII configuration service. More...
def	populate_runtime_repository (self)

Constructor & Destructor Documentation

__init__()

def cli.operations.Operations.__init__	(		self,
			config
	)

Member Function Documentation

delete_datapoints()

def cli.operations.Operations.delete_datapoints	(		self,
		str	repo_name,
		DataPointPath	path,
		bool	recursive
	)

Deletes a single datapoint or a whole hierarchy if recursive is set to True.

get_datapoint()

def cli.operations.Operations.get_datapoint	(		self,
		str	repo_name,
		DataPointPath	path,
		bool	get_type,
		bool	get_size
	)

Get and print the datapoint value to console.

   If the get_type flag is True then the datapoint type is printed instead, in the same format
   as is accepted by the --type argument.
   If the get_size flag is True then the size of the datapoint is printed instead.

get_repository()

def cli.operations.Operations.get_repository	(		self,
		str	repo
	)

Return the appropriate repository adapter based on the value of the repo option string.

init_repository_metadata()

def cli.operations.Operations.init_repository_metadata

(

self

)

Initialise the metadata for RTC Toolkit types in CII configuration service.

list_datapoints()

def cli.operations.Operations.list_datapoints	(		self,
		str	repo_name,
			path,
		bool	recursive
	)

List all available datapoints and sub-paths found under a given path.

   If the recursive flag is True then we print all datapoints found under path recursively.

parse_value()

def cli.operations.Operations.parse_value	(		self,
		str	value,
		Optional[Any]	requested_type = None
	)

populate_runtime_repository()

def cli.operations.Operations.populate_runtime_repository

(

self

)

read_hierarchy()

def cli.operations.Operations.read_hierarchy	(		self,
		str	repo_name,
		DataPointPath	path,
		str	output_path
	)

run_shell()

def cli.operations.Operations.run_shell	(		self,
		str	repo_name
	)

Setup the repository object and enter a Python shell for interactive mode.

set_datapoint()

def cli.operations.Operations.set_datapoint	(		self,
		str	repo_name,
		DataPointPath	path,
		str	value,
			requested_type
	)

Set a datapoint's value.

   If the datapoint does not exist it is created with the type indicated by requested_type.
   If the datapoint already exists and requested_type is not None then it is first cross
   checked with the datapoint's actual type.

write_hierarchy()

def cli.operations.Operations.write_hierarchy	(		self,
		str	repo_name,
		DataPointPath	path,
		str	input_path
	)

---

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

• reusableComponents/configTool/src/rtctk/configtool/cli/operations.py