File: WhyCmd.rst

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (42 lines) | stat: -rw-r--r-- 887 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
ecflow.WhyCmd
/////////////


.. py:class:: WhyCmd
   :module: ecflow

   Bases: :py:class:`~Boost.Python.instance`

The why command reports, the reason why a node is not running.

It needs the  definition structure and the path to node

Constructor::

   WhyCmd(defs, node_path)
      defs_ptr  defs   : pointer to a definition structure
      string node_path : The node path


Exceptions:

- raises RuntimeError if the definition is empty
- raises RuntimeError if the node path is empty
- raises RuntimeError if the node path cannot be found in the definition

Usage::

   try:
      ci = Client()
      ci.sync_local()
      ask = WhyCmd(ci.get_defs(),'/suite/family')
      print(ask.why())
   except RuntimeError, e:
       print(str(e))


.. py:method:: WhyCmd.why( (WhyCmd)arg1) -> str :
   :module: ecflow

returns a '/n' separated string, with reasons why node is not running