POGO Java Program


pogo.gene
Class PogoGeneDoc

java.lang.Object
  |
  +--pogo.gene.PogoGene
        |
        +--pogo.gene.PogoGeneDoc

public class PogoGeneDoc
extends PogoGene
implements PogoDefs, TangoDs.TangoConst

This class generates html Doc file.

Version:
$Revision: 1.22 $
Author:
$Author: verdier $

Field Summary
private  java.lang.String outDoc
           
private  PogoClass pogo
          Pogo Class to be used for generation.
 
Fields inherited from class pogo.gene.PogoGene
pogo, sbTrace
 
Fields inherited from interface pogo.gene.PogoDefs
ALREADY_OVERRIDING, ATTR_IMAGE, ATTR_READ, ATTR_READ_WITH_WRITE, ATTR_READ_WRITE, ATTR_SCALAR, ATTR_SPECTRUM, ATTR_WRITE, AttrDataArray, AttrRWtypeArray, AttrTypeArray, authorRes, classDescRes, cppAddAttrib, cppAddCommands, cppExtention, cppFile, cppLang, dataCommands, dataExtention, dataFile, dataStartCmd, dataStartStates, endGeneTag, errDetected, javaAddAttrib, javaAddCommands, javaExtention, javaFile, javaLang, languageRes, NEW_STR, NOT_OVERRIDE, outputFiles, OVERRIDE, pageTitleRes, pogoLang, projectTitleRes, readAttrProto1, readAttrProto2, readAttrProto3, readFile, revisionRes, startGeneTag, STATE, statesDescRes, STATUS, Tango_ALARM, Tango_CLOSE, Tango_CONST_DEV_STRING, Tango_DISABLE, Tango_EXTRACT, Tango_FAULT, Tango_INSERT, Tango_MOVING, Tango_OFF, Tango_ON, Tango_OPEN, Tango_RUNNING, Tango_STANDBY, Tango_TYPE_UNKNOWN, Tango_UNKNOWN, Tango_WARMUP, TangoStatesArray, templateBlock, templateClass, templateClassCmd, templateCmd, templateExecuteCmd, templateFile, writeAttrProto, writeFile
 
Fields inherited from interface TangoDs.TangoConst
Attr_Description, Attr_Name, Attr_State, Attr_Status, Attr_Unknown, Op_BlackBox, Op_Command, Op_Command_inout, Op_Command_list, Op_Get_Attr_Config, Op_Info, Op_Ping, Op_Read_Attr, Op_Set_Attr_Config, Op_Unknown, Op_Write_Attr, Req_Attribute, Req_Operation, Req_Unknown, Tango_AllAttr, Tango_AlrmValueNotSpec, Tango_AssocWritNotSpec, Tango_CmdArgTypeName, Tango_DbErr_DeviceNotDefined, Tango_DbObjName, Tango_DefaultBlackBoxDepth, Tango_DefaultDocUrl, Tango_DefaultWritableProp, Tango_DescNotSet, Tango_DEV_BOOLEAN, Tango_DEV_DOUBLE, Tango_DEV_FLOAT, Tango_DEV_LONG, Tango_DEV_SHORT, Tango_DEV_STATE, Tango_DEV_STRING, Tango_DEV_ULONG, Tango_DEV_USHORT, Tango_DEV_VOID, Tango_DevErr_AttrMandatoryProp, Tango_DevErr_AttrNoAlarm, Tango_DevErr_AttrNotFound, Tango_DevErr_AttrNotWritable, Tango_DevErr_AttrOptProp, Tango_DevErr_AttrValueNotSet, Tango_DevErr_BlackBoxArgument, Tango_DevErr_BlackBoxEmpty, Tango_DevErr_CannotOpenFile, Tango_DevErr_CantInstallSignal, Tango_DevErr_CantRetrieveClassList, Tango_DevErr_ClassNotFound, Tango_DevErr_CmdArgumentTypeNotSupported, Tango_DevErr_CommandNotAllowed, Tango_DevErr_CommandNotFound, Tango_DevErr_DeviceNotFound, Tango_DevErr_IncompatibleAttrDataType, Tango_DevErr_IncompatibleCmdArgumentType, Tango_DevErr_InitMethodNotFound, Tango_DevErr_InitNotPublic, Tango_DevErr_InitThrowsException, Tango_DevErr_JavaRuntimeSecurityException, Tango_DevErr_MemoryAllocation, Tango_DevErr_MethodArgument, Tango_DevErr_MethodNotFound, Tango_DevErr_OverloadingNotSupported, Tango_DevErr_SignalOutOfRange, Tango_DevErr_WAttrOutsideLimit, Tango_DevStateName, Tango_DEVVAR_CHARARRAY, Tango_DEVVAR_DOUBLEARRAY, Tango_DEVVAR_DOUBLESTRINGARRAY, Tango_DEVVAR_FLOATARRAY, Tango_DEVVAR_LONGARRAY, Tango_DEVVAR_LONGSTRINGARRAY, Tango_DEVVAR_SHORTARRAY, Tango_DEVVAR_STRINGARRAY, Tango_DEVVAR_ULONGARRAY, Tango_DEVVAR_USHORTARRAY, Tango_DevVersion, Tango_DSDeviceDomain, Tango_InitialOutput, Tango_MaxServerNameLength, Tango_ResNotDefined, Tango_SysProperty
 
Constructor Summary
PogoGeneDoc(PogoClass pogo)
          Constructor for Pogo Class Doc files generation.
 
Method Summary
 java.lang.String generate()
          Generate Html Doc files for tango device Server from Pogo Class definition
protected  void generateAttributesFile()
          Create the DevCommands.html file from template file and PogoClass Object.
protected  void generateCmdListDescriptionFile()
          Create the DevCommands.html file from template file and PogoClass Object.
protected  void generateCmdListFile()
          Create the DevCommands.html file from template file and PogoClass Object.
protected  void generateCmdTableFile()
          Create the DevCommands.html file from template file and PogoClass Object.
protected  void generateDescriptionFile()
          Create the Description.html file from template file and PogoClass Object.
protected  void generateIndexFile()
          Create the index.html file from template file and PogoClass Object.
private  java.lang.String generateProgrammersGuide()
          Generate Html Doc files for tango device Server Programmer's guide.
protected  void generateStateDescriptionFile()
          Create the DevCommands.html file from template file and PogoClass Object.
private  void makeDocDir()
           
 
Methods inherited from class pogo.gene.PogoGene
addCommentsCmdMethod, buildAttributesMethods, buildReadMeFile, changeExeMethodArgs, checkForExecMethodModif, copyFile, getTrace, mustGenerate, readAttributeTemplate, replacePatternFile, setMethodInComments, setProjectTitle
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

pogo

private PogoClass pogo
Pogo Class to be used for generation.

outDoc

private java.lang.String outDoc
Constructor Detail

PogoGeneDoc

public PogoGeneDoc(PogoClass pogo)
Constructor for Pogo Class Doc files generation.
Parameters:
pogo - Pogo Class definition used for generation.
Method Detail

makeDocDir

private void makeDocDir()

generateProgrammersGuide

private java.lang.String generateProgrammersGuide()
                                           throws java.io.FileNotFoundException,
                                                  java.lang.SecurityException,
                                                  java.io.IOException,
                                                  java.lang.InterruptedException,
                                                  PogoException
Generate Html Doc files for tango device Server Programmer's guide. This class use tools as javadoc and doc++
Returns:
Output doc. generation process.
Throws:
java.io.FileNotFoundException -  
java.lang.SecurityException -  
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateIndexFile

protected void generateIndexFile()
                          throws java.io.IOException,
                                 PogoException
Create the index.html file from template file and PogoClass Object.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateDescriptionFile

protected void generateDescriptionFile()
                                throws java.io.IOException,
                                       PogoException
Create the Description.html file from template file and PogoClass Object. This file will be filled by the programmer. For this reason, if the file already exists, it will not be overwritten.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateStateDescriptionFile

protected void generateStateDescriptionFile()
                                     throws java.io.IOException,
                                            PogoException
Create the DevCommands.html file from template file and PogoClass Object. This file will describe the device server commands in a table.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateAttributesFile

protected void generateAttributesFile()
                               throws java.io.IOException,
                                      PogoException
Create the DevCommands.html file from template file and PogoClass Object. This file will describe the device server commands in a table.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateCmdListFile

protected void generateCmdListFile()
                            throws java.io.IOException,
                                   PogoException
Create the DevCommands.html file from template file and PogoClass Object. This file will describe the device server commands in a printable list.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateCmdListDescriptionFile

protected void generateCmdListDescriptionFile()
                                       throws java.io.IOException,
                                              PogoException
Create the DevCommands.html file from template file and PogoClass Object. This file will describe the device server commands in a printable list.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generateCmdTableFile

protected void generateCmdTableFile()
                             throws java.io.IOException,
                                    PogoException
Create the DevCommands.html file from template file and PogoClass Object. This file will describe the device server commands in a table.
Throws:
java.io.IOException -  
PogoException - If a synthax error occured on input file

generate

public java.lang.String generate()
                          throws java.io.FileNotFoundException,
                                 java.lang.SecurityException,
                                 java.io.IOException,
                                 java.lang.InterruptedException,
                                 PogoException
Generate Html Doc files for tango device Server from Pogo Class definition
Returns:
Output doc. generation process.
Throws:
java.io.FileNotFoundException -  
java.lang.SecurityException -  
java.io.IOException -  
PogoException - If a synthax error occured on input file

POGO Java Program