env

Environment related macros

class dumpenv(*args, **kwargs)

Dumps the complete environment

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class load_env(*args, **kwargs)

Read environment variables from config_env.xml file

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class lsenv(*args, **kwargs)

Lists the environment in alphabetical order

prepare(macro_list, **opts)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(macro_list)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class senv(*args, **kwargs)

Sets the given environment variable to the given value

run(env, value)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class usenv(*args, **kwargs)

Unsets the given environment variable

run(env)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class genv(*args, **kwargs)

Gets the given environment variable

run(var)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class lsvo(*args, **kwargs)

Lists the view options

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class setvo(*args, **kwargs)

Sets the given view option to the given value.

Available view options:

• ShowDial: used by macro wm, pwm and wa. Default value False

• ShowCtrlAxis: used by macro wm, pwm and wa. Default value False

• PosFormat: used by macro wm, pwm and wa. Default value -1

• OutputBlock: used by scan macros. Default value False

• DescriptionLength: used by lsdef. Default value 60

run(name, value)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class usetvo(*args, **kwargs)

Resets the value of the given view option.

Available view options:

• ShowDial: used by macro wm, pwm and wa. Default value False

• ShowCtrlAxis: used by macro wm, pwm and wa. Default value False

• PosFormat: used by macro wm, pwm and wa. Default value -1

• OutputBlock: used by scan macros. Default value False

• DescriptionLength: used by lsdef. Default value 60

run(name)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class lsgh(*args, **kwargs)

List general hooks.

Note

The lsgh macro has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including its removal) may occur if deemed necessary by the core developers.

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class defgh(*args, **kwargs)

Define general hook:

>>> defgh "mv [[mot02 9]]" pre-scan
>>> defgh "ct 0.1" pre-scan
>>> defgh lsm pre-scan
>>> defgh "mv mot03 10" pre-scan
>>> defgh "Print 'Hello world'" pre-scan

Note

The defgh macro has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including its removal) may occur if deemed necessary by the core developers.

run(macro_name, position)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError

class udefgh(*args, **kwargs)

Undefine general hook. Without arguments undefine all.

Note

The lsgh macro has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including its removal) may occur if deemed necessary by the core developers.

run(macro_name, hook_pos)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises

RuntimeError