[kepler-dev] {Filename?} Kepler Javadocs

Wed Feb 22 10:49:21 PST 2006

Nandita:

Since your attachments where liked much by the virus/spam scanners,
maybe you should just put the stuff at a suitable place in the cvs and
send urls instead?

just a thought..

Bertram

>>> On Wed, 22 Feb 2006 10:39:11 -0800
>>> Nandita Mangal <nmangal at sdsc.edu> wrote: 
NM> 
NM> Warning: This message has had one or more attachments removed
NM> Warning: (OrbWaveformSource.doc.xml).
NM> Warning: Please read the "NCEAS-Attachment-Warning.txt" attachment(s) for more information.
NM> 
NM> 
NM> As discussed in Kepler meeting , we are creating kepler documentation 
NM> based on Ptolemy's documentaionFramework :
NM> 
NM> 1)A doc/doclets/PtDoclet.java reads Actor java files and generates xml using the DTD at
NM> ptolemy/vergil/basic/DocML_1.dtd.  These .xml files are in kepler-docs/dev/documentationFramework/generatedJavadocs.
NM> 
NM> Both kepler as well as ptolemy javadocs are generated and the resultant XML files are in the generatedJavadocs folder.
NM> 
NM> The javadocs are named with extension "*.doc.xml" to avoid mixup with Kepler src/actors XMLs.
NM> 
NM> 
NM> 
NM> 
NM> 2) The Javadocs Doclet contains the basic info fields and tags, and also contain a "UserLevelDocumentation" tag, to 
NM> allow Kepler to create separate "UserDocumenation" pages as well for the same actor.
NM> 
NM> 
NM> 
NM> _DeveloperDocumenation_
NM> Description
NM>  Author
NM>  Version
NM>  Ports Summary (Port Name + description)
NM>  Parameters Summary (Parameter Name + description)
NM> Sample Demos (To be added)
NM> 
NM> _User Documentation Fields_
NM>  UserLevelDescription
NM>  Author
NM>  Version
NM>  Ports Summary (Port Name + UserLevelDescription)
NM>  Parameters Summary (Parameter Name + UserLevelDescription)
NM> Sample Demos (To be added)
NM> 
NM> A sample javadoc XML file and its two user/developer HTML files created 
NM> are attached.
NM> The final documentation pages are in 
NM> kepler-docs/dev/documenationFramework/generatedHTMLPages/user (or developer)
NM> The main page with the ontology tree links to actors is 
NM> "FinalUserDocumentation.html (or FinalDeveloperDocumentation.html) in 
NM> generatedHTMLPages folder.
NM> 
NM> 
NM> 3)In progress: Fully integrate the "customizeDocumentation" feature as 
NM> implemented by Ptolemy on canvas.
NM> 
NM> Any comments/errors please let me know.
NM> 
NM> Thanks,
NM> nandita.
NM> 
NM> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
NM> <html><p><b><font size="+1" color="red">Warning: </FONT>This message has had one
NM> or more attachments removed (OrbWaveformSource.doc.xml). Please read the "NCEAS-Attachment-Warning.txt"
NM> attachment(s) for more information.</b><br /></p>
NM> 
NM> <head>
NM>   <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
NM> </head>
NM> <body bgcolor="#ffffff" text="#000000">
NM> <br>
NM> As discussed in Kepler meeting , we are creating kepler documentation
NM> based on Ptolemy's documentaionFramework :<br>
NM> <pre wrap="">1)A doc/doclets/PtDoclet.java reads Actor java files and generates xml using the DTD at
NM> ptolemy/vergil/basic/DocML_1.dtd.  These .xml files are in kepler-docs/dev/documentationFramework/generatedJavadocs.
NM> 
NM> Both kepler as well as ptolemy javadocs are generated and the resultant XML files are in the generatedJavadocs folder.
NM> 
NM> The javadocs are named with extension "*.doc.xml" to avoid mixup with Kepler src/actors XMLs.
NM> 
NM> 
NM> 
NM> 
NM> 2) The Javadocs Doclet contains the basic info fields and tags, and also contain a "UserLevelDocumentation" tag, to 
NM> allow Kepler to create separate "UserDocumenation" pages as well for the same actor.
NM> 
NM> 
NM> </pre>
NM> <p class="MsoNormal"><u>DeveloperDocumenation</u><br>
NM> Description<br>
NM> <span style="">&nbsp;</span>Author<br>
NM> <span style="">&nbsp;</span>Version<br>
NM> <span style="">&nbsp;</span>Ports Summary (Port
NM> Name + description)<br>
NM> <span style="">&nbsp;</span>Parameters Summary
NM> (Parameter Name + description)<br>
NM> Sample Demos (To be added)<br>
NM> </p>
NM> <p class="MsoNormal"></p>
NM> <p class="MsoNormal"><u>User Documentation
NM> Fields</u><br>
NM> <span style="">&nbsp;</span>UserLevelDescription<br>
NM> <span style="">&nbsp;</span>Author<br>
NM> <span style="">&nbsp;</span>Version<br>
NM> <span style="">&nbsp;</span>Ports Summary (Port
NM> Name + UserLevelDescription)<br>
NM> <span style="">&nbsp;</span>Parameters Summary
NM> (Parameter Name + UserLevelDescription)<br>
NM> Sample Demos (To be added)<br>
NM> </p>
NM> <p class="MsoNormal">A sample javadoc XML file and its two
NM> user/developer HTML files created are attached.<br>
NM> The final documentation pages are in
NM> kepler-docs/dev/documenationFramework/generatedHTMLPages/user (or
NM> developer)<br>
NM> The main page with the ontology tree links to actors is
NM> "FinalUserDocumentation.html (or FinalDeveloperDocumentation.html) in
NM> generatedHTMLPages folder.<br>
NM> </p>
NM> <p class="MsoNormal"><br>
NM> 3)In progress: Fully integrate the "customizeDocumentation" feature as
NM> implemented by Ptolemy on canvas.<br>
NM> </p>
NM> <p class="MsoNormal">Any comments/errors please let me know.</p>
NM> <p class="MsoNormal">Thanks,<br>
NM> nandita.<br>
NM> </p>
NM> </body>
NM> </html>
NM> <html>
NM> <body>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD><a href="http://kepler-project.org/"></B></FONT><FONT COLOR="Black"><B>KEPLER HOME</a></TD><TD><a href="http://ptolemy.eecs.berkeley.edu/ptolemyII/"></B></FONT><FONT COLOR="Black"><B>PTOLEMY HOME</a></TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <img src="http://roadnet.ucsd.edu/images/kepler-logo.jpg"><HR>
NM> <br>
NM> <Font size="5"><td><b>OrbWaveformSource</b></td></Font>
NM> <br>
NM> <Font size="3"><td>org.ROADnet.OrbWaveformSource</td></Font>
NM> <br>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD>
NM> <h2>Documentation</h2>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <br>
NM> This actor connects to an Antelope ORB and collects packets matching the 
NM>  given sourcename, supplying samples from waveform packets to the channels
NM>  of the output port.  Waveforms encapsulated as GEN and GENC will always go
NM>  to channel 0 of the output port.  MGENC packets may contain multiple
NM>  channels, and the samples are sent to channels 0, 1, 2, ... up to the number
NM>  of channels contained.  Make sure that the relation connected to the output
NM>  port has its "Width" parameter set properly!  <br>
NM> <br>
NM> <b> Author(s): </b>Tobin Fricke, University of California<br>
NM> <b> Version:</b>$Id: OrbWaveformSource.java,v 1.4 2005/11/01 20:39:05 ruland Exp $<br>
NM> <b> Pt.Proposed Rating:</b>Red (tobin)<br>
NM> <br>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD>
NM> <h2>Ports Summary</h2>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <br>
NM> <font size="5"><b>output</b></font>
NM> <br>Samples from incoming waveform packets appear on this port.  For
NM>   multiplexed packets (eg, MGENC format), the channels in incoming
NM>   packets are mapped to the channels of this output port.  In that
NM>   case you should verify that the "width" property of the relation
NM>   connected to this port is set to the expected number of channels.
NM>   Also, rather than connecting multiple relations directly to this
NM>   port, you should probably use a single "relation" object (black
NM>   diamond), so that all of the channels are carried on the same 
NM>   relation.  Then you can use the "Select" actor to access specific
NM>   channels.<br>
NM> <font size="5"><b>times</b></font>
NM> <br>The timestamps for individual samples are output on this port.
NM>   It's up to you to ensure that samples and their associated time
NM>   stamps are consumed synchronously.  At present, this is a single
NM>   port and the times correspond to samples on channel zero of 
NM>   packets reaped from the Orb.  Another possibility would be to
NM>   demultiplex the times in a way analagous to the way samples 
NM>   themselves are distributed.  Sample times are computed from the
NM>   start time given in each packet and the sample rate.<br>
NM> <br>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD>
NM> <h2>Parameter Summary</h2>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <br>
NM> <font size="5"><b>orbname</b></font>
NM> <br>The name of the orb to connect to, in the format "hostname:port".
NM>   Note that orbnames.pf-style names are not supported -- you have 
NM>   to use a valid IP address or resolvable DNS name, and you have 
NM>   to use a numeric port number.<br>
NM> <font size="5"><b>srcname</b></font>
NM> <br>The source name to request from the Orb.  When this actor is
NM>   initialized, orb.select() is called with the value of this 
NM>   parameter.<br>
NM> <br>
NM> </body>
NM> </html>
NM> <html>
NM> <body>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD><a href="http://kepler-project.org/"></B></FONT><FONT COLOR="Black"><B>KEPLER HOME</a></TD><TD><a href="http://ptolemy.eecs.berkeley.edu/ptolemyII/"></B></FONT><FONT COLOR="Black"><B>PTOLEMY HOME</a></TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <img src="http://roadnet.ucsd.edu/images/kepler-logo.jpg"><HR>
NM> <br>
NM> <Font size="5"><td><b>OrbWaveformSource</b></td></Font>
NM> <br>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD>
NM> <h2>Documentation</h2>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <br>
NM> <b> User Level Documentation: </b>This actor connects to the Antelope ORB and outputs 
NM>  the required sensor data stream in the form of multiple channels. The data
NM>  stream formats handled are MGENC/GENC/GEN.<br>
NM> <br>
NM> <br>
NM> <b> Author(s): </b>Tobin Fricke, University of California<br>
NM> <b> Version:</b>$Id: OrbWaveformSource.java,v 1.4 2005/11/01 20:39:05 ruland Exp $<br>
NM> <br>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD>
NM> <h2>Ports Summary</h2>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <br>
NM> <font size="5"><b>output</b></font>
NM> <br>
NM> <br>
NM> <font size="5"><b>times</b></font>
NM> <br>
NM> <br>
NM> <br>
NM> <TABLE SUMMARY="" CELLSPACING="0" CELLPADDING="1" WIDTH="100%" BORDER="0">
NM> <TR>
NM> <TD CLASS="NavBarCell1" BGCOLOR="#DDEEDD" COLSPAN="3"><A NAME="navbar_top_firstrow"></A>
NM> <TABLE SUMMARY="" CELLSPACING="10" CELLPADDING="0" BORDER="0">
NM> <TR VALIGN="top" ALIGN="center">
NM> <TD>
NM> <h2>Parameter Summary</h2>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> </TD>
NM> </TR>
NM> </TABLE>
NM> <br>
NM> <font size="5"><b>orbname</b></font>
NM> <br>The orbname refers to the specific ORB source
NM>    that you want to connect to via Antelope software in Kepler.<br>
NM> <font size="5"><b>srcname</b></font>
NM> <br>srcname indicates the specific data stream
NM>   to get data from.Sensor locations/data type might vary depending on
NM>   different data streams.<br>
NM> <br>
NM> </body>
NM> </html>
NM> This is a message from the MailScanner E-Mail Virus Protection Service
NM> ----------------------------------------------------------------------
NM> The original e-mail attachment "OrbWaveformSource.doc.xml"
NM> is on the list of unacceptable attachments for this site and has been
NM> replaced by this warning message.
NM> 
NM> If you wish to receive a copy of the original attachment, please
NM> e-mail helpdesk and include the whole of this message
NM> in your request. Alternatively, you can call them, with
NM> the contents of this message to hand when you call.
NM> 
NM> At Wed Feb 22 10:49:51 2006 the virus scanner said:
NM>    MailScanner: Attempt to hide real filename extension (OrbWaveformSource.doc.xml)
NM> 
NM> Note to Help Desk: Look on Mercury in /var/spool/MailScanner/quarantine/20060222 (message C425C3582C3.0C261).
NM> -- 
NM> Postmaster
NM> NCEAS
NM> www.nceas.uscb.edu
NM> 
NM> MailScanner thanks transtec Computers for their support
NM> _______________________________________________
NM> Kepler-dev mailing list
NM> Kepler-dev at ecoinformatics.org
NM> http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev