engine
Class ModuleDescription

java.lang.Object
  |
  +--engine.DefaultNameSpaceDescription
        |
        +--engine.UserModuleDescription
              |
              +--engine.ModuleDescription
class ModuleDescription
extends UserModuleDescription

This contains the description of the inside structure of a module (regs, integers, threads of control, etc). Its main purpose is to creatye all the instances needed inside a module ( which in turn is created by ModuleInstanceDesscription.instantiate(..)).

See Also:
Serialized Form

Field Summary
(package private)  java.lang.String fileName
          The file that contains this module description.
(package private)  int line
          The line at wich this module begins.
(package private)  boolean setParams
          set if parameters have been set for this instantiation (this means that instantiateAll must undefine them because recursive instantiation might re-use them) But I guess re-using 'em is possible only if a module is recursive instantiating itself...
 
Fields inherited from class engine.DefaultNameSpaceDescription
always, connectionHash, connectionList, events, functions, initial, monitors, name, ports, regs, regsVector, subScopes
 
Constructor Summary
(package private) ModuleDescription(java.lang.String fileName, int line, java.lang.String name)
           
 
Method Summary
(package private)  void checkPorts(NameSpace ns)
          Verifies that ports types and the corresponding data declarations work together (wire for input, etc.).
 void checkup()
          Adds wires where not explicitely declared for ports.
 java.lang.Object createNewModule(NameSpace parent, ModuleInstanceDescription miDesc, byte strength, ScopeNode thisScope)
           
 java.lang.Object createNewModuleArray(NameSpace parent, ModuleInstanceDescription miDesc, byte strength, ScopeNode thisScope, int ars, int are, int n, int increment)
           
 java.lang.String getFileName()
           
(package private)  void instantiateAll(Module m, ScopeNode thisScope)
           
 boolean isTop()
           
 void setParams(java.util.Vector results, Delay3 delays)
          Makes the parameters to hold the right values for the current instantiation
 java.lang.String toString()
           
 java.lang.String toString(int line)
           
 void unsetParams()
           
 
Methods inherited from class engine.UserModuleDescription
linkModule, linkModuleArray
 
Methods inherited from class engine.DefaultNameSpaceDescription
addAlways, addConnection, addConnection, addEvent, addFunction, addInitial, addInteger, addModuleArray, addParameter, addPort, addPort, addReal, addRealTime, addRegister, addScope, addSubModule, addTime, addWire, breakLinks, checkSymbolUnique, checkSymbolUnique, defParam, instantiateAll, isPort, name
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

fileName

java.lang.String fileName
The file that contains this module description.

line

int line
The line at wich this module begins.

setParams

boolean setParams
set if parameters have been set for this instantiation (this means that instantiateAll must undefine them because recursive instantiation might re-use them) But I guess re-using 'em is possible only if a module is recursive instantiating itself...
Constructor Detail

ModuleDescription

ModuleDescription(java.lang.String fileName,
                  int line,
                  java.lang.String name)
Method Detail

isTop

public boolean isTop()
Overrides:
isTop in class DefaultNameSpaceDescription

instantiateAll

void instantiateAll(Module m,
                    ScopeNode thisScope)
              throws ParseException

checkup

public void checkup()
             throws ParseException
Adds wires where not explicitely declared for ports.
Overrides:
checkup in class DefaultNameSpaceDescription

checkPorts

void checkPorts(NameSpace ns)
          throws ParseException
Verifies that ports types and the corresponding data declarations work together (wire for input, etc.).
Overrides:
checkPorts in class DefaultNameSpaceDescription

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(int line)
Overrides:
toString in class DefaultNameSpaceDescription

getFileName

public java.lang.String getFileName()
Overrides:
getFileName in class DefaultNameSpaceDescription

setParams

public void setParams(java.util.Vector results,
                      Delay3 delays)
               throws ParseException
Makes the parameters to hold the right values for the current instantiation

unsetParams

public void unsetParams()

createNewModule

public java.lang.Object createNewModule(NameSpace parent,
                                        ModuleInstanceDescription miDesc,
                                        byte strength,
                                        ScopeNode thisScope)
                                 throws ParseException
See Also:
ModuleFactory

createNewModuleArray

public java.lang.Object createNewModuleArray(NameSpace parent,
                                             ModuleInstanceDescription miDesc,
                                             byte strength,
                                             ScopeNode thisScope,
                                             int ars,
                                             int are,
                                             int n,
                                             int increment)
                                      throws ParseException