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

YadaMain Class Reference

Inheritance diagram for YadaMain:

Inheritance graph
[legend]
Collaboration diagram for YadaMain:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaMain - The root of the YADA application. This class is serves as a mediator between the different components of the application. Its main tasks are

So in order to talk to one specific part of the application a method in YadaMain is available delegating a task to the correct component. The YadaMain is also used to query components of the application, i.e. YadaDocuments, only known at runtime by their symbolic name.

All YadaDocuments loaded at system startup and those created during runtime are registered with YadaMain::registerDocument() and from there on known to the application so that the user can switch to it. All registered YadaDocuments are kept in the YadaMain::_registeredDocument hash. The YadaDocument::nextDocument and YadaDocument::prevDocument establish a double linked list of all known documents where the head and the tail of the list are stored in YadaMain::_firstDocument and YadaMain::_lastDocument respectively. Showing a registered document is the achieved by YadaMain::activateDocument().

Author:
Michael Daum
Id
YadaMain.tcl,v 1.18 2004/09/06 13:41:13 micha Exp

Definition at line 40 of file YadaMain.tcl.

Public Member Functions

 activateDocument (YadaDocument document="")
 document (TclString docName, TclList args)
 getActiveExperiments (TclList args)
 getDocument (TclString name)
 getDocuments (TclList args)
 getEditor ()
 getExperiment (TclString experimentName)
 getExperimentNames (TclList args)
 getExperiments (TclList args)
 getGrammar (TclString grammarName)
 getGrammarNames (TclList args)
 getGrammarOfExperiment (TclString experimentName)
 getGrammars (TclList args)
 getMachine (TclString name)
 getMachineNames (TclList args)
 getMachines (TclList args)
 getPersistanceFileNameForExperiment (TclString experimentName)
 getPersistanceFileNameForGrammar (TclString grammarName)
 getPersistanceFileNameForMachine (TclString machineName)
 getPersistanceFileNameForMisc ()
 getPersistanceFileNameForRanking (TclString rankingName)
 getPersistanceFileNameForRunner (TclString runnerName)
 getSignificance ()
 getTimeTolerance ()
 getToggle (TclString name)
 getWeirdness ()
 getWordgraphsOfExperiment (TclString experimentName)
 init ()
 newDocument (TclString className, TclString docName)
 printStatus (TclString message)
 quit ()
 registerDocument (YadaDocument document)
 setToggle (TclString name, TclString value="")
 unregisterDocument (YadaDocument document)
 YadaMain (TclList args)
 ~YadaMain ()

Private Member Functions

 _about ()

Private Attributes

TclString _currentDocument = ""
TclString _currentDocumentName = ""
TclString _currentToolbar = ""
TclString _firstDocument = ""
TclString _lastDocument = ""
TclArray _registeredDocument
TclString _status = ""
TclNumber _statusFlag = 1
TclNumber _toolbarFlag = 1


Constructor & Destructor Documentation

YadaMain::YadaMain TclList  args  ) 
 

constructor. This constructor builds up all widgets and packs them into one megawidget.

Parameters:
args are handed over to itk_initialize() to initialize this megawidget
Definition at line 125 of file YadaMain.tcl.

YadaMain::~YadaMain  ) 
 

destructor

Definition at line 304 of file YadaMain.tcl.

References activateDocument().


Member Function Documentation

YadaMain::_about  )  [private]
 

_about

Definition at line 721 of file YadaMain.tcl.

YadaMain::activateDocument YadaDocument  document = ""  ) 
 

activateDocument

Definition at line 310 of file YadaMain.tcl.

Referenced by ~YadaMain().

YadaMain::document TclString  docName,
TclList  args
 

delegate a task to a named YadaDocument. This method fetches the YadaDocument named name and passes over the arguments args as a command.

Parameters:
docName the name of the YadaDocument
args passed commands
Returns:
the result of the YadaDocument call
Definition at line 714 of file YadaMain.tcl.

YadaMain::getActiveExperiments TclList  args  ) 
 

getActiveExperiments

Definition at line 506 of file YadaMain.tcl.

YadaMain::getDocument TclString  name  ) 
 

getDocument

Definition at line 611 of file YadaMain.tcl.

YadaMain::getDocuments TclList  args  ) 
 

getDocuments

Definition at line 622 of file YadaMain.tcl.

YadaMain::getEditor  ) 
 

getEditor

Definition at line 604 of file YadaMain.tcl.

YadaMain::getExperiment TclString  experimentName  ) 
 

getExperiment

Definition at line 483 of file YadaMain.tcl.

YadaMain::getExperimentNames TclList  args  ) 
 

getExperimentNames

Definition at line 498 of file YadaMain.tcl.

YadaMain::getExperiments TclList  args  ) 
 

getExperiments

Definition at line 490 of file YadaMain.tcl.

YadaMain::getGrammar TclString  grammarName  ) 
 

getGrammar

Definition at line 515 of file YadaMain.tcl.

YadaMain::getGrammarNames TclList  args  ) 
 

getGrammarNames

Definition at line 531 of file YadaMain.tcl.

YadaMain::getGrammarOfExperiment TclString  experimentName  ) 
 

getGrammarOfExperiment

Definition at line 562 of file YadaMain.tcl.

YadaMain::getGrammars TclList  args  ) 
 

getGrammars

Definition at line 523 of file YadaMain.tcl.

YadaMain::getMachine TclString  name  ) 
 

getMachine

Definition at line 539 of file YadaMain.tcl.

YadaMain::getMachineNames TclList  args  ) 
 

getMachineNames

Definition at line 554 of file YadaMain.tcl.

YadaMain::getMachines TclList  args  ) 
 

getMachines

Definition at line 546 of file YadaMain.tcl.

YadaMain::getPersistanceFileNameForExperiment TclString  experimentName  ) 
 

Returns unique file path dependent on experiment name.

delete blanks in name Definition at line 740 of file YadaMain.tcl.

YadaMain::getPersistanceFileNameForGrammar TclString  grammarName  ) 
 

methods for getting unique file paths to save object state

delete blanks in name Definition at line 731 of file YadaMain.tcl.

YadaMain::getPersistanceFileNameForMachine TclString  machineName  ) 
 

Returns unique file path dependent on machine name.

delete blanks in name Definition at line 749 of file YadaMain.tcl.

YadaMain::getPersistanceFileNameForMisc  ) 
 

Returns unique file path for general configuration tab.

Definition at line 758 of file YadaMain.tcl.

YadaMain::getPersistanceFileNameForRanking TclString  rankingName  ) 
 

Returns unique file path for ranking documents.

delete blanks in name Definition at line 774 of file YadaMain.tcl.

YadaMain::getPersistanceFileNameForRunner TclString  runnerName  ) 
 

Returns unique file path for runner documents.

delete blanks in name Definition at line 765 of file YadaMain.tcl.

YadaMain::getSignificance  ) 
 

getSignificance

Definition at line 590 of file YadaMain.tcl.

YadaMain::getTimeTolerance  ) 
 

getTimeTolerance

Definition at line 597 of file YadaMain.tcl.

YadaMain::getToggle TclString  name  ) 
 

getToggle

Definition at line 654 of file YadaMain.tcl.

YadaMain::getWeirdness  ) 
 

getWeirdness

Definition at line 583 of file YadaMain.tcl.

YadaMain::getWordgraphsOfExperiment TclString  experimentName  ) 
 

getWordgraphsOfExperiment

Definition at line 572 of file YadaMain.tcl.

YadaMain::init  ) 
 

init

Definition at line 276 of file YadaMain.tcl.

YadaMain::newDocument TclString  className,
TclString  docName
 

newDocument

Definition at line 448 of file YadaMain.tcl.

YadaMain::printStatus TclString  message  ) 
 

printStatus

Definition at line 646 of file YadaMain.tcl.

YadaMain::quit  ) 
 

quit

Definition at line 440 of file YadaMain.tcl.

YadaMain::registerDocument YadaDocument  document  ) 
 

registerDocument

Definition at line 370 of file YadaMain.tcl.

YadaMain::setToggle TclString  name,
TclString  value = ""
 

setToggle

Definition at line 671 of file YadaMain.tcl.

YadaMain::unregisterDocument YadaDocument  document  ) 
 

unregisterDocument

Definition at line 400 of file YadaMain.tcl.


Member Data Documentation

TclString YadaMain::_currentDocument = "" [private]
 

currently visible YadaDocument

Definition at line 49 of file YadaMain.tcl.

TclString YadaMain::_currentDocumentName = "" [private]
 

name of the currently visible document embedded into the main widget

Definition at line 46 of file YadaMain.tcl.

TclString YadaMain::_currentToolbar = "" [private]
 

toolbar of the currently visible YadaDocument

Definition at line 52 of file YadaMain.tcl.

TclString YadaMain::_firstDocument = "" [private]
 

head of the list of all YadaDocuments

Definition at line 58 of file YadaMain.tcl.

TclString YadaMain::_lastDocument = "" [private]
 

tail of the list of all YadaDocuments

Definition at line 61 of file YadaMain.tcl.

TclArray YadaMain::_registeredDocument [private]
 

hash of all known YadaDocuments matching a symbolic name to its YadaDocument

Definition at line 55 of file YadaMain.tcl.

TclString YadaMain::_status = "" [private]
 

current status message. Use printStatus() to change its contents. Definition at line 71 of file YadaMain.tcl.

TclNumber YadaMain::_statusFlag = 1 [private]
 

toggle to switch on and off the status line

Definition at line 67 of file YadaMain.tcl.

TclNumber YadaMain::_toolbarFlag = 1 [private]
 

toggle to switch on and off the toolbar

Definition at line 64 of file YadaMain.tcl.


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