diagapplet.CodeGen
Interface CodeGenCommonInterface


public interface CodeGenCommonInterface

Provides an interface for the Diagnostics tool and Design Tools to CodeGenCommon without a circular dependancy that directly using the class would cause.


Field Summary
static java.lang.String ndla_len_string
           
static java.lang.String ndla_string
           
static java.lang.String PARAM_AddSetHeader
           
static java.lang.String PARAM_ConfigFile
           
static java.lang.String PARAM_CreatePrintSizesFile
           
static java.lang.String PARAM_DebugOn
           
static java.lang.String PARAM_DisplayOn
           
static java.lang.String PARAM_DlaLengthInit
           
static java.lang.String PARAM_GenerateAllEnumSymbolLookups
           
static java.lang.String PARAM_GenerateForAda
           
static java.lang.String PARAM_GenerateForAllLangs
           
static java.lang.String PARAM_GenerateForC
           
static java.lang.String PARAM_GenerateForCPP
           
static java.lang.String PARAM_GenerateForJava
           
static java.lang.String PARAM_GenerateSymbolLookups
           
static java.lang.String PARAM_HeaderFile
           
static java.lang.String PARAM_HFile
           
static java.lang.String PARAM_HHFile
           
static java.lang.String PARAM_HierarchyFile
           
static java.lang.String PARAM_JavaPackageName
           
static java.lang.String PARAM_NoErrlog
           
static java.lang.String PARAM_PrintScript
           
static java.lang.String PARAM_ScriptFile
           
static java.lang.String PARAM_SelectFromAllFiles
           
static java.lang.String PARAM_SizesFileName
           
static java.lang.String PARAM_UpdateWithName
           
static java.lang.String PARAM_UseDefaultTypes
           
static java.lang.String unbounded_string
           
 
Method Summary
 void AddAuxBufferModule(java.lang.String buffer_name, java.lang.String header, java.lang.String nml_file)
          Adds Information related to an auxilliary buffer.
 FastListPanelInterface get_ClassList()
          Get the ClassList property.
 DiagNMLMsgDictCreatorInterface get_diag_dict_creator()
          Get the diag_dict_creator property.
 java.util.Vector get_extraActionsVector()
          Returns an extrActionsVector().
 java.util.Vector get_extraTabsVector()
          Returns an extrTabsVector().
 java.lang.String get_m_hierarchyFile()
          Get the hierarchyFile property.
 java.util.Hashtable get_m_modulesHashTable()
          Returns the modulesHashTable property.
 FastListPanelInterface get_m_modulesList()
          Get the ModulesList property.
 NMLConnectionCreatorInterface get_nml_creator()
          Get the nml_creator property.
 java.util.Hashtable get_optionsHashTable()
          Returns the optionsHashTable property.
 java.lang.String GetParameter(java.lang.String strName, java.lang.String[] args)
          Return the value of the matching strName if one exist(), optionally searching command line args given in args.
 boolean is_interrupt_loading()
          Return the value of the interrupt_loading property.
 void LoadHierarchy()
          Load the hierarchy parsing the file set with set_m_hierarchyFile().
 void set_ClassList(FastListPanelInterface flp)
          Set the ClassList property.
 void set_diag_dict_creator(DiagNMLMsgDictCreatorInterface _diag_dict_creator)
          Set a diag_dict_creator property.
 void set_interrupt_loading(boolean b)
          Set the value of the interrupt_loading property.
 void set_m_hierarchyFile(java.lang.String str)
          Set the hierarchyFile property.
 void set_m_modulesList(FastListPanelInterface lst)
          Set the ModulesList property.
 void set_nml_creator(NMLConnectionCreatorInterface _nml_creator)
          Set the nml_creator property.
 

Field Detail

PARAM_HierarchyFile

static final java.lang.String PARAM_HierarchyFile
See Also:
Constant Field Values

PARAM_ConfigFile

static final java.lang.String PARAM_ConfigFile
See Also:
Constant Field Values

PARAM_HeaderFile

static final java.lang.String PARAM_HeaderFile
See Also:
Constant Field Values

PARAM_HFile

static final java.lang.String PARAM_HFile
See Also:
Constant Field Values

PARAM_HHFile

static final java.lang.String PARAM_HHFile
See Also:
Constant Field Values

PARAM_ScriptFile

static final java.lang.String PARAM_ScriptFile
See Also:
Constant Field Values

PARAM_DebugOn

static final java.lang.String PARAM_DebugOn
See Also:
Constant Field Values

PARAM_UpdateWithName

static final java.lang.String PARAM_UpdateWithName
See Also:
Constant Field Values

PARAM_CreatePrintSizesFile

static final java.lang.String PARAM_CreatePrintSizesFile
See Also:
Constant Field Values

PARAM_SelectFromAllFiles

static final java.lang.String PARAM_SelectFromAllFiles
See Also:
Constant Field Values

PARAM_SizesFileName

static final java.lang.String PARAM_SizesFileName
See Also:
Constant Field Values

PARAM_GenerateSymbolLookups

static final java.lang.String PARAM_GenerateSymbolLookups
See Also:
Constant Field Values

PARAM_GenerateAllEnumSymbolLookups

static final java.lang.String PARAM_GenerateAllEnumSymbolLookups
See Also:
Constant Field Values

PARAM_AddSetHeader

static final java.lang.String PARAM_AddSetHeader
See Also:
Constant Field Values

PARAM_GenerateForC

static final java.lang.String PARAM_GenerateForC
See Also:
Constant Field Values

PARAM_GenerateForAllLangs

static final java.lang.String PARAM_GenerateForAllLangs
See Also:
Constant Field Values

PARAM_GenerateForCPP

static final java.lang.String PARAM_GenerateForCPP
See Also:
Constant Field Values

PARAM_GenerateForJava

static final java.lang.String PARAM_GenerateForJava
See Also:
Constant Field Values

PARAM_GenerateForAda

static final java.lang.String PARAM_GenerateForAda
See Also:
Constant Field Values

PARAM_JavaPackageName

static final java.lang.String PARAM_JavaPackageName
See Also:
Constant Field Values

PARAM_DlaLengthInit

static final java.lang.String PARAM_DlaLengthInit
See Also:
Constant Field Values

PARAM_DisplayOn

static final java.lang.String PARAM_DisplayOn
See Also:
Constant Field Values

PARAM_UseDefaultTypes

static final java.lang.String PARAM_UseDefaultTypes
See Also:
Constant Field Values

PARAM_NoErrlog

static final java.lang.String PARAM_NoErrlog
See Also:
Constant Field Values

PARAM_PrintScript

static final java.lang.String PARAM_PrintScript
See Also:
Constant Field Values

ndla_string

static final java.lang.String ndla_string
See Also:
Constant Field Values

ndla_len_string

static final java.lang.String ndla_len_string
See Also:
Constant Field Values

unbounded_string

static final java.lang.String unbounded_string
See Also:
Constant Field Values
Method Detail

is_interrupt_loading

boolean is_interrupt_loading()
Return the value of the interrupt_loading property. It is generally set from one thread to end a long CodeGen function in another thread safely and needs to be checked from wihin each loop.

Returns:
interrupt_loading property.

set_interrupt_loading

void set_interrupt_loading(boolean b)
Set the value of the interrupt_loading property. This should cause any function likely to take a long time in another thread to return an error quickly.

Parameters:
b - new value of interupt_loading property.

get_m_modulesHashTable

java.util.Hashtable get_m_modulesHashTable()
Returns the modulesHashTable property. This is a HashTable matching module names (Strings) to ModuleInfo objects. The use of a generic hashtable rather than Hashtable is to maintain Java 1.4 compatibility.

Returns:
m_modulesHashTable

get_optionsHashTable

java.util.Hashtable get_optionsHashTable()
Returns the optionsHashTable property. This is a Hashtable macthing String option names to String values. Options can be set with command line parameters, int the options section of a config file or .diag file or with environment variables. The use of a generic hashtable rather than Hashtable is to maintain Java 1.4 compatibility.

Returns:
the hashtable.

get_m_hierarchyFile

java.lang.String get_m_hierarchyFile()
Get the hierarchyFile property. A string containing the name/URL of the last loaded hiearchyFile optionally including the path.

Returns:
hierarchy file name.

set_m_hierarchyFile

void set_m_hierarchyFile(java.lang.String str)
Set the hierarchyFile property.

Parameters:
str -

get_ClassList

FastListPanelInterface get_ClassList()
Get the ClassList property. Depending on whether this is run from a graphical tool or not the ClassList may simply wrap a Vector of strings of the class names or a Graphical widget for displaying selecting them.

Returns:
ClassList

set_ClassList

void set_ClassList(FastListPanelInterface flp)
Set the ClassList property. Depending on whether this is run from a graphical tool or not the ClassList may simply wrap a Vector of strings of the class names or a Graphical widget for displaying selecting them.

Parameters:
flp -

get_m_modulesList

FastListPanelInterface get_m_modulesList()
Get the ModulesList property. Depending on whether this is run from a graphical tool or not the ModulesList may simply wrap a Vector of strings of the module names or a Graphical widget for displaying selecting them.

Returns:
modulesList

set_m_modulesList

void set_m_modulesList(FastListPanelInterface lst)
Set the ModulesList property. Depending on whether this is run from a graphical tool or not the ModulesList may simply wrap a Vector of strings of the module names or a Graphical widget for displaying selecting them.

Parameters:
lst -

LoadHierarchy

void LoadHierarchy()
                   throws java.lang.Exception
Load the hierarchy parsing the file set with set_m_hierarchyFile().

Throws:
java.lang.Exception

set_diag_dict_creator

void set_diag_dict_creator(DiagNMLMsgDictCreatorInterface _diag_dict_creator)
Set a diag_dict_creator property. Only used by diagnostics tool. This object create DiagNMLMsgDict objects indirectly in a way to avoid circular dependancy.

Parameters:
_diag_dict_creator -

get_diag_dict_creator

DiagNMLMsgDictCreatorInterface get_diag_dict_creator()
Get the diag_dict_creator property. Only used by diagnostics tool.

Returns:
diag_dict_creator

set_nml_creator

void set_nml_creator(NMLConnectionCreatorInterface _nml_creator)
Set the nml_creator property. Used only by the diagnostics tools. This object create NMLConnecton objects indirectly in a way to avoid circular dependancy.

Parameters:
_nml_creator -

get_nml_creator

NMLConnectionCreatorInterface get_nml_creator()
Get the nml_creator property.

Returns:
nml_creator.

GetParameter

java.lang.String GetParameter(java.lang.String strName,
                              java.lang.String[] args)
Return the value of the matching strName if one exist(), optionally searching command line args given in args. Parameters can also be found in environment variables or the options section of the diag file.

Parameters:
strName -
args -
Returns:
value

AddAuxBufferModule

void AddAuxBufferModule(java.lang.String buffer_name,
                        java.lang.String header,
                        java.lang.String nml_file)
Adds Information related to an auxilliary buffer. Only used by diagnostics tool.

Parameters:
buffer_name -
header -
nml_file -

get_extraActionsVector

java.util.Vector get_extraActionsVector()
Returns an extrActionsVector(). It is a vector of strings read from the config file. The diagnostics tool adds an menu item at run time for each item in the vector.

Returns:
extraActionsVector()

get_extraTabsVector

java.util.Vector get_extraTabsVector()
Returns an extrTabsVector(). It is a vector of strings read from the config file. The diagnostics tool adds a tab at run time for each item in the vector.

Returns:
extraTabsVector()