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

YadaConfig Class Reference
[YadaConfiguration - managing configurations]

Inheritance diagram for YadaConfig:

Inheritance graph
[legend]
Collaboration diagram for YadaConfig:

Collaboration graph
[legend]
List of all members.

Detailed Description

YadaConfig - the configuration document

Author:
Michael Daum
Id
YadaConfig.tcl,v 1.15 2004/03/25 13:58:23 ddreyer Exp

Definition at line 19 of file YadaConfig.tcl.

Public Member Functions

 activationHandle ()
 backward ()
 deActivationHandle ()
 displayTitle ()
 document (TclString docName, TclList args)
 forward ()
 fromDOM (domNode node)
 getPersistanceFileName ()
 hasSavedState ()
 init ()
 isModified ()
 lastChanged ()
 load ()
 loadUpdatedWordgraphs (TclList args)
 resetModified ()
 save ()
 setModified ()
 setToggle (TclString name, TclRef value="")
 toDOM ()
 YadaConfig (TclList args)

Static Public Member Functions

 newDocument (TclString className, TclString name)

Public Attributes

TclString hasView = "true"
TclString name = ""
YadaDocument nextDocument
YadaDocument prevDocument

Protected Member Functions

 askNewLoad ()
 updateModificationTime ()

Protected Attributes

TclNumber _isInitialized = 0
TclNumber _lastModificationTime = 0
TclNumber _modified = 0

Private Member Functions

 _activateDocument (TclString docName)

Private Attributes

TclString _currentDocumentName = ""


Constructor & Destructor Documentation

YadaConfig::YadaConfig TclList  args  ) 
 

constructor

Definition at line 44 of file YadaConfig.tcl.


Member Function Documentation

YadaConfig::_activateDocument TclString  docName  )  [private]
 

_activateDocument

Definition at line 236 of file YadaConfig.tcl.

YadaConfig::activationHandle  )  [virtual]
 

activationHandle

Reimplemented from YadaDocument.

Definition at line 227 of file YadaConfig.tcl.

YadaDocument::askNewLoad  )  [protected, inherited]
 

Pops up a yes/no message dialog and returns the result (i.e. which button has been pressed) Definition at line 330 of file YadaDocument.tcl.

YadaDocument::backward  )  [inherited]
 

backward

Definition at line 236 of file YadaDocument.tcl.

References YadaDocument::forward().

YadaConfig::deActivationHandle  )  [virtual]
 

deActivationHandle

Reimplemented from YadaPlainDocument.

Definition at line 257 of file YadaConfig.tcl.

YadaPlainDocument::displayTitle  )  [inherited]
 

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

Reimplemented in YadaConfigDocument, YadaGenerals, YadaRanking, and YadaRunner.

Definition at line 207 of file YadaPlainDocument.tcl.

YadaConfig::document TclString  docName,
TclList  args
 

document

Definition at line 268 of file YadaConfig.tcl.

YadaDocument::forward  )  [inherited]
 

forward

Definition at line 243 of file YadaDocument.tcl.

References YadaDocument::prevDocument.

Referenced by YadaDocument::backward().

YadaPlainDocument::hasSavedState  )  [inherited]
 

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

Referenced by YadaPlainDocument::resetModified().

YadaConfig::init  )  [virtual]
 

initialize the YADA configuration. This method initializes the yada config document and all its subdocuments, that is all init scripts are sourced. Doing so we generate YadaConfigItem objects and collet them all separately in the appropriate subdocuments. So the following init scripts in YADA_ETC are sourced in the given order:

  • configure.tcl: this is an application level init script
  • grammars.tcl: generate all YadaGrammar objects and assert them into YadaGrammars
  • machines.tcl: generate all YadaMachine objects and assert them into YadaMachines
  • experiments.tcl: generate all YadaExperiment objects and assert them into YadaExperiments Hint: the init scripts might source further init scripts. This lets you organize different init scripts for different purposes.

Reimplemented from YadaPlainDocument.

Definition at line 192 of file YadaConfig.tcl.

YadaPlainDocument::isModified  )  [inherited]
 

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

Definition at line 168 of file YadaPlainDocument.tcl.

References YadaPlainDocument::setModified().

YadaPlainDocument::lastChanged  )  [inherited]
 

Returns time of last update to document XML file or an empty string, if there is no such file Definition at line 219 of file YadaPlainDocument.tcl.

YadaConfig::load  ) 
 

load

Reimplemented from YadaPlainDocument.

Definition at line 132 of file YadaConfig.tcl.

YadaDocument::newDocument TclString  className,
TclString  name
[static, inherited]
 

newDocument

Definition at line 319 of file YadaDocument.tcl.

YadaPlainDocument::resetModified  )  [inherited]
 

Removes modification mark.

Definition at line 183 of file YadaPlainDocument.tcl.

References YadaPlainDocument::hasSavedState().

Referenced by YadaPlainDocument::setModified().

YadaConfig::save  ) 
 

save

Reimplemented from YadaPlainDocument.

Definition at line 162 of file YadaConfig.tcl.

YadaPlainDocument::setModified  )  [inherited]
 

Marks item as modified.

Definition at line 175 of file YadaPlainDocument.tcl.

References YadaPlainDocument::resetModified().

Referenced by YadaPlainDocument::isModified().

YadaDocument::setToggle TclString  name,
TclRef  value = ""
[inherited]
 

toggle toolbar or status. This method switches the toolbar or the status bar on or off depending on its arguments.

Parameters:
name the element to be toggled: toolbar or status
value the value to which to switch to: 1 or 0

Reimplemented from YadaPlainDocument.

Reimplemented in YadaRunnableDocument.

Definition at line 300 of file YadaDocument.tcl.

YadaPlainDocument::updateModificationTime  )  [protected, inherited]
 

Synchronizes internal modification attribute with modification time of document's XML file Definition at line 234 of file YadaPlainDocument.tcl.


Member Data Documentation

TclNumber YadaPlainDocument::_isInitialized = 0 [protected, inherited]
 

flag indicating initialization. Possible falues are 0 and 1. init() sets this to 1 when it is called in the init chain calls of inheriting classes, i.e. YadaConfigDocument::init() or YadaRunnableDocument::init(). Definition at line 36 of file YadaPlainDocument.tcl.

TclNumber YadaPlainDocument::_lastModificationTime = 0 [protected, inherited]
 

Denotes time of most recent modification of document's XML file CAUSED by this object. This allows recognizing cases where a second object modifies the same file concurrently, in which case the need may arise to synchronize the object with the new file contents. Definition at line 44 of file YadaPlainDocument.tcl.

TclString YadaPlainDocument::hasView = "true" [inherited]
 

flag indicating whether this object functions as combined model-view object (value "true"), or as a pure model object (value "false": has to be set explicitly when instantiating object) Definition at line 29 of file YadaPlainDocument.tcl.

TclString YadaPlainDocument::name = "" [inherited]
 

name of the document

Definition at line 25 of file YadaPlainDocument.tcl.

YadaDocument::nextDocument [inherited]
 

link to the next YadaDocument registered to YadaMain

Definition at line 265 of file YadaDocument.tcl.

YadaDocument::prevDocument [inherited]
 

link to the previous YadaDocument registered to YadaMain

Definition at line 250 of file YadaDocument.tcl.

Referenced by YadaDocument::forward().


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