Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

YadaExperiment Class Reference
[YadaConfiguration - managing configurationsYadaScheduler - the data workhorse]

Inheritance diagram for YadaExperiment:

Inheritance graph
[legend]
Collaboration diagram for YadaExperiment:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaExperiment - bundled information about a experiment. A YadaExperiment is the central object of the YADA application. It brings together all the parts that are needed to start YadaJob objects forking the parser process in the background and consuming the produced data.

So a YadaExperiment

All YadaExperiment objects are accessed via the YadaExperiments configuration document. YadaGrammars and YadaMachines that are available are configured separately.

Author:
Michael Daum
Id
YadaExperiment.tcl,v 1.11 2004/10/15 17:24:37 micha Exp

Definition at line 36 of file YadaExperiment.tcl.

Public Member Functions

 check ()
 clone (TclList args)
 displayTitle ()
 fromDOM (domNode rootNode)
 getDocFileName ()
 getLogFileName (TclString wgName)
 getPersistanceFileName ()
 getXmlFileName (TclString wgName)
 hasSavedState ()
 isModified ()
 load ()
 print (TclString message)
 resetModified ()
 resetStatistics ()
 save ()
 setModified ()
 start (YadaJob job)
 toDOM ()
 YadaExperiment (TclList args)

Public Attributes

TclString command = ""
TclString dataDir = ""
TclString grammarName = ""
TclNumber isActive = 1
TclNumber isComplete = 0
TclNumber isUpToDate = 0
TclNumber labelledHits = 0
TclNumber lexicalHits = 0
TclString machineName = "localhost"
TclRef name
TclString printCommand = ""
TclString script = ""
TclNumber strictHits = 0
TclNumber structHits = 0
TclNumber totalScore = 0
TclNumber totalSoftTime = 0
TclNumber totalSolTime = 0
TclNumber totalTime = 0
TclNumber totalTries = 0
TclString type = ""

Protected Attributes

TclNumber _modified = 0


Constructor & Destructor Documentation

YadaExperiment::YadaExperiment TclList  args  ) 
 

constructor

Definition at line 221 of file YadaExperiment.tcl.


Member Function Documentation

YadaConfigItem::displayTitle  )  [inherited]
 

Displays title in main window (reflecting modification state of document).

Definition at line 128 of file YadaConfigItem.tcl.

YadaConfigItem::hasSavedState  )  [inherited]
 

Predicate returning 1, if file containing persistant state of YadaGrammar exists, otherwise 0 Definition at line 115 of file YadaConfigItem.tcl.

YadaConfigItem::isModified  )  [inherited]
 

Predicate returning 1, if configuration data has changed, 0 otherwise.

Definition at line 87 of file YadaConfigItem.tcl.

YadaConfigItem::load  )  [inherited]
 

Loads object state from unique file (depends on object name).

Definition at line 66 of file YadaConfigItem.tcl.

YadaConfigItem::resetModified  )  [inherited]
 

Removes modification mark.

Definition at line 105 of file YadaConfigItem.tcl.

YadaConfigItem::save  )  [inherited]
 

Serializes object state to unique file (depends on object name).

Definition at line 45 of file YadaConfigItem.tcl.

YadaConfigItem::setModified  )  [inherited]
 

Marks item as modified.

Definition at line 94 of file YadaConfigItem.tcl.


Member Data Documentation

TclString YadaExperiment::command = ""
 

path to cdgp binary file

Definition at line 61 of file YadaExperiment.tcl.

TclString YadaExperiment::dataDir = ""
 

path where to store all computed data files

Definition at line 64 of file YadaExperiment.tcl.

TclString YadaExperiment::grammarName = ""
 

YadaGrammar to appy this experiment.

Definition at line 67 of file YadaExperiment.tcl.

TclNumber YadaExperiment::isActive = 1
 

flag indicating whether this experiment is currently waiting for a YadaJob to finish. Definition at line 77 of file YadaExperiment.tcl.

TclNumber YadaExperiment::isComplete = 0
 

flag indicating whether all data has been computed for this experiment, so no more YadaJobs are needed. Definition at line 81 of file YadaExperiment.tcl.

TclNumber YadaExperiment::isUpToDate = 0
 

flag indicating whether all statistics in all data has been collected or not. Definition at line 85 of file YadaExperiment.tcl.

TclNumber YadaExperiment::labelledHits = 0
 

labelled hits collected in the experiments data files.

Definition at line 95 of file YadaExperiment.tcl.

TclNumber YadaExperiment::lexicalHits = 0
 

lexical hits collected in the experiments data files.

Definition at line 101 of file YadaExperiment.tcl.

TclString YadaExperiment::machineName = "localhost"
 

YadaMachine where to schedule resulting YadaJobs on.

Definition at line 70 of file YadaExperiment.tcl.

TclString YadaExperiment::printCommand = ""
 

tcl command used to print a message.

See also:
print()
Definition at line 89 of file YadaExperiment.tcl.

TclString YadaExperiment::script = ""
 

CDGP script to feed into the STDIN of a CdgProcess.

Definition at line 73 of file YadaExperiment.tcl.

TclNumber YadaExperiment::strictHits = 0
 

strict hits collected in the experiments data files.

Definition at line 98 of file YadaExperiment.tcl.

TclNumber YadaExperiment::structHits = 0
 

struct hits collected in the experiments data files.

Definition at line 104 of file YadaExperiment.tcl.

TclNumber YadaExperiment::totalScore = 0
 

total scores collected in the experiments data files.

Definition at line 92 of file YadaExperiment.tcl.

TclNumber YadaExperiment::totalSoftTime = 0
 

total soft time collected in the experiments data files.

Definition at line 116 of file YadaExperiment.tcl.

TclNumber YadaExperiment::totalSolTime = 0
 

total solution time collected in the experiments data files.

Definition at line 113 of file YadaExperiment.tcl.

TclNumber YadaExperiment::totalTime = 0
 

total time collected in the experiments data files.

Definition at line 110 of file YadaExperiment.tcl.

TclNumber YadaExperiment::totalTries = 0
 

total number of tries collected in the experiments data files.

Definition at line 107 of file YadaExperiment.tcl.

TclString YadaExperiment::type = ""
 

the name of the experiment

the type of the experiment. The type of the experiment specifies the parsing flavour used. Possible sensefull values by now are

  • annotation (which is actually now parsing flavour but a way to compute parses via anno2parse())
  • arcconsistency
  • frobbing
  • genetic
  • gls
  • incremental completion
  • isearch
  • netsearch
  • pruning
  • wfst
Definition at line 58 of file YadaExperiment.tcl.


The documentation for this class was generated from the following file:
YADA 2.0-alpha (20 Oct 2004)