Configuration Tool

The rtctkConfigTool is a command line tool used to inspect, retrieve and manipulate configuration data from the Runtime Configuration Repository.

Operations

ConfigTool allows different kinds of operations on a repository.

The following operations are possible:

  • get

  • set

  • delete

  • list

  • read

  • write

  • get-type

Get

Get is used to retrieve the contents of a single DataPoint. You have to specify the repository and the path to the DataPoint you want to get.

Example

$ rtctkConfigTool --repo file:///repo --path /data/my_data_point --get

Set

Set is used to change or create a DataPoint. If the DataPoint does not exist it will be created with the type given by --type. Otherwise the type of the existing DataPoint has to match the type given by --type. Currently only scalar types are accepted. For Vectors and Matrices use the write operation.

Example

$ rtctkConfigTool --repo file:///repo --path /data/my_data_point --set --type RtcInt32 --value 42

Delete

Delete removes a DataPoint given by --repo and --path.

Example

$ rtctkConfigTool --repo file:///repo --path /data/my_data_point --delete

List

Shows the sub-paths and datapoints within a DataPoint path given by --repo and --path.

Example

$ rtctkConfigTool --repo file:///repo --path /data/ --list
Data Points:
RtcInt32: /data/my_data_point

Sub Paths:

Read

Read can be used to write the contents of a DataPoint to a FITS file. The fits file is given using the --file argument.

Example

$ rtctkConfigTool --repo file:///repo --path /my_data_point --read --file data_dump.fits

Write

Write can be used to write the contents of a FITS file into a DataPoint. The fits file is given using the --file argument.

Example

$ rtctkConfigTool --repo file:///repo --path /my_data_point --write \
--file my_new_data_point_data.fits

Get-type

Get-type can be used to get the type of a DataPoint in the repository.

Example

$ rtctkConfigTool --repo file:///repo --path /my_data_point --get-type
RtcInt32

Differences From the Design Document

  • In the alpha release only the command line interface is implemented.

  • The repo argument does not take “persistent” or “runtime” but rather a file URI to the repository.