env

Environment related macros

class dumpenv(*args, **kwargs)[source]

Dumps the complete environment

class lsvo(*args, **kwargs)[source]

Lists the view options

class setvo(*args, **kwargs)[source]

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
class usetvo(*args, **kwargs)[source]

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
class lsenv(*args, **kwargs)[source]

Lists the environment in alphabetical order

class senv(*args, **kwargs)[source]

Sets the given environment variable to the given value

class usenv(*args, **kwargs)[source]

Unsets the given environment variable

class load_env(*args, **kwargs)[source]

Read environment variables from config_env.xml file

class lsgh(*args, **kwargs)[source]

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.

class defgh(*args, **kwargs)[source]

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.

class udefgh(*args, **kwargs)[source]

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.