Module azcam.tools.system

Contains the base System tool. The System class contains custom code for a specific system, including "system header" commands.

Classes

class System (system_name, template_file=None)

System tool class. Usually implemented as the "system" tool.

Args

tool_id
name used to reference the tool (controller, display, …)
description
description of this tool

Ancestors

Instance variables

var description

Inherited from: Tools.description

descriptive tool name

var enabled

Inherited from: Tools.enabled

1 when tool is enabled

var initialized

Inherited from: Tools.initialized

1 when tool has been initialized

var is_reset

Inherited from: Tools.is_reset

1 when tool has been reset

var tool_id

Inherited from: Tools.tool_id

name used to reference the tool ("controller", "display", …)

var verbosity

Inherited from: Tools.verbosity

verbosity for debug, >0 is more verbose

Methods

def define_keywords(self)

Inherited from: ObjectHeaderMethods.define_keywords

Defines and resets keywords.

def delete_keyword(self, keyword: str)

Inherited from: ObjectHeaderMethods.delete_keyword

Delete a keyword.

Args

keyword
keyword
def get_keyword(self, keyword: str) ‑> list

Inherited from: ObjectHeaderMethods.get_keyword

Return a keyword value, its comment string, and type. Comment always returned in double quotes, even if empty.

Args

keyword
name of keyword

def get_keywords(self) ‑> list

Inherited from: ObjectHeaderMethods.get_keywords

Return a list of all keyword names.

Returns

keywords
list of all keywords
def initialize(self) ‑> None

Inherited from: Tools.initialize

Initialize the tool.

def read_header(self) ‑> list

Inherited from: ObjectHeaderMethods.read_header

Reads and returns current header data.

Returns

list of header lines
[Header[]]: Each element Header[i] contains the sublist (keyword, value, …
def reset(self) ‑> None

Inherited from: Tools.reset

Reset the tool.

def set_keyword(self, keyword: str, value: Any, comment: str = 'none', typestring: str = 'none')

Inherited from: ObjectHeaderMethods.set_keyword

Set a keyword value, comment, and type.

Args

keyword
keyword
value
value of keyword
comment
comment string
typestring
one of …
def update_header(self)

Inherited from: ObjectHeaderMethods.update_header

Update the header, reading current data. Deletes all keywords if the object is not enabled.