ecflow.Label

class ecflow.Label

Bases: instance

A label has a name and value and provides a way of displaying information in a GUI.

The value can be anything(ASCII) as it cannot be used in triggers. The value of the label is set to be the default value given in the definition when the suite is begun. This is useful in repeated suites: A task sets the label to be something.

Labels can be set at any level: Suite,Family,Task. There are two ways of updating the label

• A child command can be used to automatically update the label on a task

• Using the alter command, the labels on suite family and task can be changed manually

Constructor:

Label(name,value)
   string name:  The name of the label
   string value: The value of the label

Usage:

t1 = Task('t1',
          Label('name','value'),  # create Labels in-place
          Label('a','b'))
t1.add_label('l1','value')
t1.add_label(Label('l2','value2'))
for label in t1.labels:
   print(label)

Label.empty((Label)arg1) → bool :

Return true if the Label is empty. Used when returning a NULL Label, from a find

Label.name((Label)arg1) → str :

Return the label name as string

Label.new_value((Label)arg1) → str :

Return the new label value as string

Label.value((Label)arg1) → str :

Return the original label value as string