[cig-commits] commit:

[Mercurial]

changeset:   85:b956ba8014b2
user:        JulianGiordani
date:        Wed May 14 02:31:55 2008 +0000
files:       Swarm/src/SwarmOutput.meta
description:
SwarmOutput.meta file done


diff -r 1b63e3744d93 -r b956ba8014b2 Swarm/src/SwarmOutput.meta
--- a/Swarm/src/SwarmOutput.meta	Wed May 14 02:29:24 2008 +0000
+++ b/Swarm/src/SwarmOutput.meta	Wed May 14 02:31:55 2008 +0000
@@ -5,15 +5,15 @@
 <param name="Name">SwarmOutput</param>
 <param name="Author">...</param>
 <param name="Organisation">VPAC</param>
-<param name="Project">StGermain</param>
-<param name="Location">./StGermain/Discretisation/Swarm/src/</param>
+<param name="Project">StDomain</param>
+<param name="Location">./StgDomain/Swarm/src/</param>
 <param name="Project Web">https://csd.vpac.org/twiki/bin/view/Stgermain/WebHome</param>
 <param name="Copyright">StGermain Framework. Copyright (C) 2003-2005 VPAC.</param>
 <param name="License">The Gnu Lesser General Public License http://www.gnu.org/licenses/lgpl.html</param>
 <param name="Parent">Stg_Component</param>
 <param name="Reference">...</param>
 <param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">This component creates output files for a swarm. It creates one file per particle in the swarm and with each timestep the file grows with a line been printed in the file. The information it prints is: particle ID number, timeStep, currentTime, particle x-coord, particle y-coord, particle z-coord</param>
 
 <!--Now the interesting stuff-->
 
@@ -22,26 +22,26 @@
 	<struct>
 		<param name="Name">baseFilename</param>
 		<param name="Type">String</param>
-		<param name="Default">self->name</param>
-		<param name="Description">...</param>
+		<param name="Default">The instance name of this component</param>
+		<param name="Description">The filename of the output file within the output directory</param>
 	</struct>
 	<struct>
 		<param name="Name">columnWidth</param>
 		<param name="Type">UnsignedInt</param>
 		<param name="Default">12</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the column width of entries in the file</param>
 	</struct>
 	<struct>
 		<param name="Name">decimalLength</param>
 		<param name="Type">UnsignedInt</param>
 		<param name="Default">6</param>
-		<param name="Description">...</param>
+		<param name="Description">Defines the decimal place length of entries in the file</param>
 	</struct>
 	<struct>
 		<param name="Name">borderString</param>
 		<param name="Type">String</param>
-		<param name="Default">"    " )</param>
-		<param name="Description">...</param>
+		<param name="Default">   </param>
+		<param name="Description">Defines column borders, by default it's a tab</param>
 	</struct>
 
 </list>
@@ -51,21 +51,8 @@
 		<param name="Essential">True</param>
 		<param name="Name">Swarm</param>
 		<param name="Type">Swarm</param>
-		<param name="Description">...</param>
+		<param name="Description">The swarm who's information will be output in the file</param>
 	</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 208 of the c file and then remove this comment afterwards -->
-
-	<struct>
-		<param name="Essential">True</param>
-		<param name="Name">context</param>
-		<param name="Type">AbstractContext</param>
-		<param name="Description">...</param>
-	</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 209 of the c file and then remove this comment afterwards -->
-
-
 </list>
 <!-- Add an exmaple XML if possible -->
 <param name="Example">...</param>