OMF

1. The OMF Experiment Description Language (OEDL)¶

OMF provides a Domain-specific Language to describe an experiment. This language is named OEDL for 'OMF Experiment Description Language'.

OEDL consists of a set of specific OMF commands and statements, and is based on the Ruby language. As a new user you do not need to know Ruby to write experiment description with OEDL. You can get started with only some basic OEDL commands and some general entry-level programming knowledge. We provide a set of basic tutorials to help you write your first experiments.

As explained in the overview page, an OMF Experiment Description (ED) is composed of 2 parts in the following order:

• Resource Description & Configuration: this part enumerates the required experimental resources, and describes their required initial configuration

• Event & Task Description: this part enumerates a list of events and associated tasks,
  • the Experiment Controller (EC) monitors these events during the experiment's runtime
  • when one of these events occurs, the EC executes the associated tasks

In addition to these 2 parts, an ED may contain an optional Graph Definition section, which describes the graph(s) to be displayed during runtime on the EC's webpage.

2. OEDL Command Reference¶

• This list a list of OEDL commands
  • some commands can only be used within other commands, this is reflected in the hierarchy used below
  • the order of the categories below is the same as you would usually see in an ED

Resource Description & Configuration

• Experiment Property Definition
  • defProperty - for Experiment
  • property

• Application Definition
  • defApplication
    • defProperty - for Application
    • defMeasurement

• Prototype Definition
  • defPrototype
    • defProperty - for Prototype
    • addApplication
      • bindProperty
      • measure
        • filter
        • metric

• Topology Definition
  • defTopology
    • addNode / removeNode / size
    • addLink / removeLink
    • getNode / getFirstNode / getLastNode / getRandomNode / getUniqueRandomNode
    • eachNode / hasNode
    • setStrict / unsetStrict

• Group Definition and Access
  • defGroup
    • addApplication
      • setProperty
      • measure
        • filter
        • metric
    • addPrototype
    • _resource path_
  • allGroups
    • _resource path_
  • group
    • _resource path_

Event & Task Description

• defEvent
  • default built-in Events

• onEvent
  • info, warn, debug, error
  • wait
  • allGroups
    • _resource path_
  • group
    • _resource path_
  • _resource path_
    • startApplications
    • stopApplications
    • sendMessage
  • Experiment.ID
  • Experiment.done

Graph Definition

• addTab
  • addGraph
    • ms
    • addLine