RTC Toolkit  2.0.0
Functions | Variables
rtctk_config_tool Namespace Reference

Functions

def cli (config, service_discovery_endpoint, log_level, runtime_repo_endpoint, persistent_repo_endpoint, quiet)
 
def gui ()
 Start the graphical application. More...
 
def shell (repo)
 
def list (repo, path, recursive)
 
def get (repo, path, type, size)
 
def set (repo, path, value, type)
 
def read (repo, path, output)
 
def write (repo, path, input)
 
def delete (repo, path, recursive)
 
def init_metadata ()
 Initialise the type metadata in the CII confguration service. More...
 
def populate ()
 
def main ()
 

Variables

 version
 RTC Configuration Tool. More...
 
 message
 
 type
 List all available datapoint paths under a given path hierarchy. More...
 
 help
 
 is_flag
 
 True
 
 flag_value
 
 default
 Enter an interactive shell. More...
 
 False
 
 context_settings
 Set a datapoint value. More...
 
 None
 

Function Documentation

◆ cli()

def rtctk_config_tool.cli (   config,
  service_discovery_endpoint,
  log_level,
  runtime_repo_endpoint,
  persistent_repo_endpoint,
  quiet 
)

◆ delete()

def rtctk_config_tool.delete (   repo,
  path,
  recursive 
)

◆ get()

def rtctk_config_tool.get (   repo,
  path,
  type,
  size 
)

◆ gui()

def rtctk_config_tool.gui ( )

Start the graphical application.

Start the graphical application to visually explore and possibly modify the configuration repositories.

NOT IMPLEMENTED

◆ init_metadata()

def rtctk_config_tool.init_metadata ( )

Initialise the type metadata in the CII confguration service.

◆ list()

def rtctk_config_tool.list (   repo,
  path,
  recursive 
)

◆ main()

def rtctk_config_tool.main ( )

◆ populate()

def rtctk_config_tool.populate ( )

◆ read()

def rtctk_config_tool.read (   repo,
  path,
  output 
)

◆ set()

def rtctk_config_tool.set (   repo,
  path,
  value,
  type 
)

◆ shell()

def rtctk_config_tool.shell (   repo)

◆ write()

def rtctk_config_tool.write (   repo,
  path,
  input 
)

Variable Documentation

◆ context_settings

rtctk_config_tool.context_settings

Set a datapoint value.

If the datapoint does not exist it will be created. If a type is provided then that type is used for the new datapoint. Otherwise the type is deduced from the Python literal value provided.

PATH indicates the datapoint path to write to.

VALUE the new value for the datapoint given as a Python literal expression.

◆ default

rtctk_config_tool.default

Enter an interactive shell.

◆ False

rtctk_config_tool.False

◆ flag_value

rtctk_config_tool.flag_value

◆ help

rtctk_config_tool.help

◆ is_flag

rtctk_config_tool.is_flag

◆ message

rtctk_config_tool.message

◆ None

rtctk_config_tool.None

◆ True

rtctk_config_tool.True

◆ type

rtctk_config_tool.type

List all available datapoint paths under a given path hierarchy.

Delete an existing datapoint or hierarchy.

Write a datapoint or hierarchy with data from local file(s).

Read a datapoint or hierarchy into local file(s).

Get a datapoint value.

PATH indicates the path to query.

Reads a datapoint from the repository indicated by 'runtime' or 'persistent' and prints the value to the terminal. If the datapoint is a large vector or matrix then the output will be truncated.

PATH indicates the datapoint path to read from.

PATH the datapoint or hierarchy path to read from.

OUTPUT the path of the YAML or FITS file that will contain the fetched data.

PATH the datapoint or hierarchy path to write to.

INPUT the path of the YAML or FITS file that contains the data to write.

PATH the datapoint or hierarchy path to delete.

◆ version

rtctk_config_tool.version

RTC Configuration Tool.

This is used to view or manipulate the Runtime Configuration Repository and/or Persistent Configuration Repository.