Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> [ engine overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of engine.FunctionDescription JAVADOC | Sourc code of engine.FunctionDescription SOURCE | Download engine.FunctionDescription DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

engine
Class FunctionDescription  view FunctionDescription download FunctionDescription.java

java.lang.Object
  extended byengine.DefaultNameSpaceDescription
      extended byengine.FunctionDescription
All Implemented Interfaces:
NameSpaceDescription, java.io.Serializable
class FunctionDescription
extends DefaultNameSpaceDescription

Field Summary
(package private)  java.util.Vector always
           
(package private)  java.util.Hashtable connectionHash
          Contains the same data as connectionList, but only if this module supports named connections.
(package private)  java.util.Vector connectionList
          Contains the list of the connections to the outside world
(package private)  java.util.Hashtable events
           
(package private)  java.util.Vector functions
           
(package private)  java.util.Vector initial
           
(package private)  InstructionDescription instruction
           
(package private)  java.util.Vector monitors
           
(package private)  java.lang.String name
          The name of this namespace.
(package private)  NameSpaceDescription nsd
           
(package private)  java.util.Vector ports
          The list of ports & their types
(package private)  java.util.Hashtable regs
           
(package private)  java.util.Vector regsVector
           
(package private)  Symbol resultDescription
           
(package private)  java.util.Hashtable subScopes
           
 
Constructor Summary
private FunctionDescription(NameSpaceDescription nsd, java.lang.String name, int lineNo)
           
(package private) FunctionDescription(NameSpaceDescription nsd, java.lang.String name, int lineNo, ExpressionDescription msb, ExpressionDescription lsb)
           
(package private) FunctionDescription(NameSpaceDescription nsd, java.lang.String name, int lineNo, int type)
           
 
Method Summary
 void addAlways(InstructionDescription ins, int lineNo)
           
 void addConnection(int lineNo, AssignableSelection lValue, ExpressionDescription rValue, Delay3Description delays, byte strength)
           
 void addConnection(java.lang.String name, int lineNo, ExpressionDescription portExp)
           
 void addEvent(java.lang.String name, int lineNo)
           
 void addFunction(java.lang.String name, int lineNo)
           
 void addInitial(InstructionDescription ins, int lineNo)
           
 void addInstruction(InstructionDescription i)
           
 void addInteger(java.lang.String name, int lineNo, ExpressionDescription arrayStart, ExpressionDescription arrayEnd)
           
 void addModuleArray(java.lang.String moduleName, int lineNo, java.lang.String descName, ExpressionDescription arrayStart, ExpressionDescription arrayEnd, java.util.Vector portsVector, java.util.Hashtable portsHash, java.util.Vector parameters, byte strength, Delay3Description delays)
           
 void addParameter(java.lang.String name, int lineNo)
           
 void addPort(java.lang.String name, int lineNo, int type)
           
 void addPort(java.lang.String name, int lineNo, int type, ExpressionDescription msb, ExpressionDescription lsb)
           
 void addReal(java.lang.String name, int lineNo)
           
 void addRealTime(java.lang.String name, int lineNo)
           
 void addRegister(java.lang.String name, int lineNo, ExpressionDescription msb, ExpressionDescription lsb, ExpressionDescription arrayStart, ExpressionDescription arrayEnd)
           
 void addScope(NameSpaceDescription theScope, int lineNo)
          Adds a new sub-scope within this nameSpace.
 void addSubModule(java.lang.String moduleName, int lineNo, java.lang.String descName, java.util.Vector portsVector, java.util.Hashtable portsHash, java.util.Vector parameters, byte strength, Delay3Description delays)
          Adds a submodule into this nameSpace.
 void addTime(java.lang.String name, int lineNo)
           
 void addWire(java.lang.String name, int lineNo, ExpressionDescription msb, ExpressionDescription lsb, int expandType, int netType, Delay3Description delays)
           
(package private)  void checkPorts(NameSpace ns)
          The default implementation here does nothing
(package private)  void checkSymbolUnique(java.lang.String name, int lineNo)
           
(package private)  void checkSymbolUnique(java.lang.String name, int lineNo, boolean checkPorts)
          Checks whether this name is unique inside this namespace.
 void checkup()
          the default here implementation does nothing
(package private)  java.util.Vector createParams(NameSpace funcSpace, java.util.Vector paramExps)
          Check that the tansfer of these parameters if possible and creates instances for the actual parameters.
 void defParam(java.lang.String name, ExpressionDescription ex)
           
 java.lang.String getFileName()
           
 void instantiateAll(NameSpace ns, middle.ScopeNode thisScope)
           
 PortDescription isPort(java.lang.String name)
           
 boolean isTop()
           
 DefaultInstruction makeInstructionInstance(NameSpace funcSpace)
          Instantiates the instruction.
 java.lang.String name()
           
(package private)  void storeParamValues(java.util.Vector paramExps, java.util.Vector paramInstances)
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 java.lang.String toString(int line)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

instruction

InstructionDescription instruction

nsd

NameSpaceDescription nsd

resultDescription

Symbol resultDescription

name

java.lang.String name
The name of this namespace.

regs

java.util.Hashtable regs

regsVector

java.util.Vector regsVector

events

java.util.Hashtable events

subScopes

java.util.Hashtable subScopes

monitors

java.util.Vector monitors

initial

java.util.Vector initial

always

java.util.Vector always

functions

java.util.Vector functions

ports

java.util.Vector ports
The list of ports & their types

connectionList

java.util.Vector connectionList
Contains the list of the connections to the outside world

connectionHash

java.util.Hashtable connectionHash
Contains the same data as connectionList, but only if this module supports named connections.

Constructor Detail

FunctionDescription

private FunctionDescription(NameSpaceDescription nsd,
                            java.lang.String name,
                            int lineNo)
                     throws ParseException

FunctionDescription

FunctionDescription(NameSpaceDescription nsd,
                    java.lang.String name,
                    int lineNo,
                    int type)
              throws ParseException

FunctionDescription

FunctionDescription(NameSpaceDescription nsd,
                    java.lang.String name,
                    int lineNo,
                    ExpressionDescription msb,
                    ExpressionDescription lsb)
              throws ParseException
Method Detail

isTop

public boolean isTop()
Overrides:
isTop in class DefaultNameSpaceDescription

addInstruction

public void addInstruction(InstructionDescription i)

addModuleArray

public void addModuleArray(java.lang.String moduleName,
                           int lineNo,
                           java.lang.String descName,
                           ExpressionDescription arrayStart,
                           ExpressionDescription arrayEnd,
                           java.util.Vector portsVector,
                           java.util.Hashtable portsHash,
                           java.util.Vector parameters,
                           byte strength,
                           Delay3Description delays)
                    throws ParseException
Specified by:
addModuleArray in interface NameSpaceDescription
Overrides:
addModuleArray in class DefaultNameSpaceDescription

addSubModule

public void addSubModule(java.lang.String moduleName,
                         int lineNo,
                         java.lang.String descName,
                         java.util.Vector portsVector,
                         java.util.Hashtable portsHash,
                         java.util.Vector parameters,
                         byte strength,
                         Delay3Description delays)
                  throws ParseException
Description copied from class: DefaultNameSpaceDescription
Adds a submodule into this nameSpace. portsHash and portsVactor cannot be both non-empty.

Specified by:
addSubModule in interface NameSpaceDescription
Overrides:
addSubModule in class DefaultNameSpaceDescription

addInitial

public void addInitial(InstructionDescription ins,
                       int lineNo)
Specified by:
addInitial in interface NameSpaceDescription
Overrides:
addInitial in class DefaultNameSpaceDescription

addAlways

public void addAlways(InstructionDescription ins,
                      int lineNo)
Specified by:
addAlways in interface NameSpaceDescription
Overrides:
addAlways in class DefaultNameSpaceDescription

addFunction

public void addFunction(java.lang.String name,
                        int lineNo)
                 throws ParseException
Specified by:
addFunction in interface NameSpaceDescription
Overrides:
addFunction in class DefaultNameSpaceDescription

addWire

public void addWire(java.lang.String name,
                    int lineNo,
                    ExpressionDescription msb,
                    ExpressionDescription lsb,
                    int expandType,
                    int netType,
                    Delay3Description delays)
             throws ParseException
Specified by:
addWire in interface NameSpaceDescription
Overrides:
addWire in class DefaultNameSpaceDescription

checkup

public void checkup()
             throws ParseException
Description copied from class: DefaultNameSpaceDescription
the default here implementation does nothing

Overrides:
checkup in class DefaultNameSpaceDescription

instantiateAll

public void instantiateAll(NameSpace ns,
                           middle.ScopeNode thisScope)
                    throws ParseException
Specified by:
instantiateAll in interface NameSpaceDescription
Overrides:
instantiateAll in class DefaultNameSpaceDescription

makeInstructionInstance

public DefaultInstruction makeInstructionInstance(NameSpace funcSpace)
                                           throws ParseException
Instantiates the instruction. This is done for every function call instruction, after the actual parameters have been linked.

createParams

java.util.Vector createParams(NameSpace funcSpace,
                              java.util.Vector paramExps)
                        throws ParseException
Check that the tansfer of these parameters if possible and creates instances for the actual parameters.

storeParamValues

void storeParamValues(java.util.Vector paramExps,
                      java.util.Vector paramInstances)

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

toString

public java.lang.String toString(int line)
Specified by:
toString in interface NameSpaceDescription
Overrides:
toString in class DefaultNameSpaceDescription

getFileName

public java.lang.String getFileName()
Specified by:
getFileName in interface NameSpaceDescription
Overrides:
getFileName in class DefaultNameSpaceDescription

name

public java.lang.String name()
Specified by:
name in interface NameSpaceDescription

addParameter

public void addParameter(java.lang.String name,
                         int lineNo)
                  throws ParseException
Specified by:
addParameter in interface NameSpaceDescription

defParam

public void defParam(java.lang.String name,
                     ExpressionDescription ex)
              throws ParseException
Specified by:
defParam in interface NameSpaceDescription

addPort

public void addPort(java.lang.String name,
                    int lineNo,
                    int type)
             throws ParseException
Specified by:
addPort in interface NameSpaceDescription

addPort

public void addPort(java.lang.String name,
                    int lineNo,
                    int type,
                    ExpressionDescription msb,
                    ExpressionDescription lsb)
             throws ParseException
Specified by:
addPort in interface NameSpaceDescription

addConnection

public void addConnection(java.lang.String name,
                          int lineNo,
                          ExpressionDescription portExp)
                   throws ParseException
Specified by:
addConnection in interface NameSpaceDescription

addScope

public void addScope(NameSpaceDescription theScope,
                     int lineNo)
              throws ParseException
Adds a new sub-scope within this nameSpace.

Specified by:
addScope in interface NameSpaceDescription

checkSymbolUnique

void checkSymbolUnique(java.lang.String name,
                       int lineNo,
                       boolean checkPorts)
                 throws ParseException
Checks whether this name is unique inside this namespace.

checkSymbolUnique

void checkSymbolUnique(java.lang.String name,
                       int lineNo)
                 throws ParseException

isPort

public PortDescription isPort(java.lang.String name)

addRegister

public void addRegister(java.lang.String name,
                        int lineNo,
                        ExpressionDescription msb,
                        ExpressionDescription lsb,
                        ExpressionDescription arrayStart,
                        ExpressionDescription arrayEnd)
                 throws ParseException
Specified by:
addRegister in interface NameSpaceDescription

addInteger

public void addInteger(java.lang.String name,
                       int lineNo,
                       ExpressionDescription arrayStart,
                       ExpressionDescription arrayEnd)
                throws ParseException
Specified by:
addInteger in interface NameSpaceDescription

addReal

public void addReal(java.lang.String name,
                    int lineNo)
             throws ParseException
Specified by:
addReal in interface NameSpaceDescription

addConnection

public void addConnection(int lineNo,
                          AssignableSelection lValue,
                          ExpressionDescription rValue,
                          Delay3Description delays,
                          byte strength)
                   throws ParseException
Specified by:
addConnection in interface NameSpaceDescription

addTime

public void addTime(java.lang.String name,
                    int lineNo)
             throws ParseException
Specified by:
addTime in interface NameSpaceDescription

addRealTime

public void addRealTime(java.lang.String name,
                        int lineNo)
                 throws ParseException
Specified by:
addRealTime in interface NameSpaceDescription

addEvent

public void addEvent(java.lang.String name,
                     int lineNo)
              throws ParseException
Specified by:
addEvent in interface NameSpaceDescription

checkPorts

void checkPorts(NameSpace ns)
          throws ParseException
The default implementation here does nothing

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> [ engine overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of engine.FunctionDescription JAVADOC | Sourc code of engine.FunctionDescription SOURCE | Download engine.FunctionDescription DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD