[QuantLibAddin-cvs] QuantLibAddin/gensrc/metadata ohfunctions.xml, 1.3, 1.4

[Eric E. <eri...@us...>]

Update of /cvsroot/quantlibaddin/QuantLibAddin/gensrc/metadata
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv8715/gensrc/metadata

Modified Files:
	ohfunctions.xml 
Log Message:
excend autogenerated QLA docs to include all OH functions

Index: ohfunctions.xml
===================================================================
RCS file: /cvsroot/quantlibaddin/QuantLibAddin/gensrc/metadata/ohfunctions.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** ohfunctions.xml	4 Sep 2006 19:21:04 -0000	1.3
--- ohfunctions.xml	4 Oct 2006 13:31:32 -0000	1.4
***************
*** 9,116 ****
  </copyright>
  
! <Functions>
  
! <Procedure name='ohSetLogFile'>
! <description>begin logging to named file</description>
! <alias>ObjHandler::setLogFile</alias>
! <supportedPlatforms>
!   <supportedPlatform>c</supportedPlatform>
!   <supportedPlatform>guile</supportedPlatform>
! </supportedPlatforms>
! <ParameterList>
! <Parameters>
!     <Parameter name='logFileName'>
!         <type>string</type>
          <tensorRank>scalar</tensorRank>
!         <description>path and name of log file</description>
!     </Parameter>
!     <Parameter name='logLevel' default='4'>
          <type>long</type>
          <tensorRank>scalar</tensorRank>
!         <description>threshold for log messages</description>
!     </Parameter>
! </Parameters>
! </ParameterList>
! <ReturnValue>
!     <type>string</type>
!     <tensorRank>scalar</tensorRank>
! </ReturnValue>
! </Procedure>
  
! <Procedure name='ohLogMessage'>
! <description>log a message</description>
! <alias>ObjHandler::logMessage</alias>
! <supportedPlatforms>
!   <supportedPlatform>c</supportedPlatform>
!   <supportedPlatform>guile</supportedPlatform>
! </supportedPlatforms>
! <ParameterList>
! <Parameters>
!     <Parameter name='logMessage'>
          <type>string</type>
          <tensorRank>scalar</tensorRank>
!         <description>message to be logged</description>
!     </Parameter>
!     <Parameter name='logLevel' default='4'>
          <type>long</type>
          <tensorRank>scalar</tensorRank>
!         <description>threshold for log messages</description>
!     </Parameter>
! </Parameters>
! </ParameterList>
! <ReturnValue>
!     <type>void</type>
!     <tensorRank>scalar</tensorRank>
! </ReturnValue>
! </Procedure>
  
! <Procedure name='ohLogObject'>
! <description>write object description to log file</description>
! <alias>ObjHandler::logObject</alias>
! <supportedPlatforms>
!   <supportedPlatform>c</supportedPlatform>
!   <supportedPlatform>guile</supportedPlatform>
! </supportedPlatforms>
! <ParameterList>
! <Parameters>
!     <Parameter name='handleObject'>
          <type>string</type>
          <tensorRank>scalar</tensorRank>
!         <description>handle of object to be logged</description>
!     </Parameter>
! </Parameters>
! </ParameterList>
! <ReturnValue>
!     <type>void</type>
!     <tensorRank>scalar</tensorRank>
! </ReturnValue>
! </Procedure>
  
! <Procedure name='ohSetConsole'>
! <description>fork output to stdout</description>
! <alias>ObjHandler::setConsole</alias>
! <supportedPlatforms>
!   <supportedPlatform>c</supportedPlatform>
!   <supportedPlatform>guile</supportedPlatform>
! </supportedPlatforms>
! <ParameterList>
! <Parameters>
!     <Parameter name='console'>
!         <type>int</type>
          <tensorRank>scalar</tensorRank>
!         <description>1 (enable) / 0 (disable)</description>
!     </Parameter>
!     <Parameter name='logLevel' default='4'>
!         <type>long</type>
          <tensorRank>scalar</tensorRank>
!         <description>threshold for log messages</description>
!     </Parameter>
! </Parameters>
! </ParameterList>
! <ReturnValue>
!     <type>void</type>
!     <tensorRank>scalar</tensorRank>
! </ReturnValue>
! </Procedure>
  
  </Functions>
--- 9,461 ----
  </copyright>
  
!   <Functions>
  
!     <Procedure name='ohCallGC'>
!       <description>delete orphaned objects from repository</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().collectGarbage</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='deletePermanent' default='false'>
!             <type>bool</type>
!             <tensorRank>scalar</tensorRank>
!             <description>also delete permanent objects</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>void</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohDeleteAllObjects'>
!       <description>delete all objects from repository</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().deleteAllObjects</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='deletePermanent' default='false'>
!             <type>bool</type>
!             <tensorRank>scalar</tensorRank>
!             <description>also delete permanent objects</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>void</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohDeleteObject'>
!       <description>delete object from repository</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().deleteObject</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='ObjectID'>
!             <type>string</type>
!             <tensorRank>scalar</tensorRank>
!             <description>ID of object to be deleted</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>void</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohDependsOn'>
!       <description>forces a dependency between two functions and returns the update counter</description>
!       <alias>ObjHandler::dependsOn</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='dummy0' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy1' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy2' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy3' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy4' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy5' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy6' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy7' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy8' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!           <Parameter name='dummy9' ignore='true'>
!             <type>any</type>
!             <tensorRank>scalar</tensorRank>
!             <description>dummy parameter (ignored)</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
          <type>long</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
  
!     <Procedure name='ohFunctionCount'>
!       <description>returns the number of functions in this addin</description>
!       <alias>ObjHandler::version</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters/>
!       </ParameterList>
!       <ReturnValue>
!         <type>long</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohListObjectIDs'>
!       <description>list the IDs of objects in repository matching regex</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().listObjectIDs</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='regex'>
!             <type>string</type>
!             <tensorRank>scalar</tensorRank>
!             <description>optional matching pattern in UNIX format (wildcard is .*)</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
          <type>string</type>
+         <tensorRank>vector</tensorRank>
+       </ReturnValue>
+     </Procedure>
+ 
+     <Procedure name='ohLogAllObjects'>
+       <description>write all object descriptions to log file</description>
+       <alias>ObjHandler::logAllObjects</alias>
+       <documentationOnly>true</documentationOnly>
+       <supportedPlatforms>
+         <supportedPlatform>excel</supportedPlatform>
+       </supportedPlatforms>
+       <ParameterList>
+         <Parameters/>
+       </ParameterList>
+       <ReturnValue>
+         <type>void</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohLogMessage'>
!       <description>log a message</description>
!       <alias>ObjHandler::logMessage</alias>
!       <supportedPlatforms>
!         <supportedPlatform>c</supportedPlatform>
!         <supportedPlatform>guile</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='logMessage'>
!             <type>string</type>
!             <tensorRank>scalar</tensorRank>
!             <description>message to be logged</description>
!           </Parameter>
!           <Parameter name='logLevel' default='4'>
!             <type>long</type>
!             <tensorRank>scalar</tensorRank>
!             <description>threshold for log messages</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>void</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohLogObject'>
!       <description>write object description to log file</description>
!       <alias>ObjHandler::logObject</alias>
!       <supportedPlatforms>
!         <supportedPlatform>c</supportedPlatform>
!         <supportedPlatform>guile</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='objectID'>
!             <type>string</type>
!             <tensorRank>scalar</tensorRank>
!             <description>ID of object to be logged</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>void</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohObjectCount'>
!       <description>#/objects in repository</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().objectCount</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters/>
!       </ParameterList>
!       <ReturnValue>
          <type>long</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
  
!     <Procedure name='ohPack'>
!       <description>trim error values from bottom/right of matrix/vector</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().packMatrix</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='inputRange'>
!             <type>any</type>
!             <tensorRank>matrix</tensorRank>
!             <description>scalar/vector/matrix of values to be packed</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>any</type>
!         <tensorRank>matrix</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohParseField'>
!       <description>Extract the ith number from a whitespace-delimited list of fields</description>
!       <alias>ObjHandler::parseField</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='line'>
!             <type>string</type>
!             <tensorRank>scalar</tensorRank>
!             <description>text to be parsed</description>
!           </Parameter>
!           <Parameter name='index'>
!             <type>long</type>
!             <tensorRank>scalar</tensorRank>
!             <description>index (1-based) of desired field</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>double</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Member name='ohPropertyNames' objectClass='Object'>
!       <description>retrieve the property names of a given object</description>
!       <libraryFunction>propertyNames</libraryFunction>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters/>
!       </ParameterList>
!       <ReturnValue>
          <type>string</type>
+         <tensorRank>vector</tensorRank>
+       </ReturnValue>
+     </Member>
+ 
+     <Member name='ohPropertyValue' objectClass='Object' dependencyTrigger='true'>
+       <description>retrieve the value of a named property</description>
+       <libraryFunction>propertyValue</libraryFunction>
+       <documentationOnly>true</documentationOnly>
+       <supportedPlatforms>
+         <supportedPlatform>excel</supportedPlatform>
+       </supportedPlatforms>
+       <ParameterList>
+         <Parameters>
+           <Parameter name='fieldName'>
+             <type>string</type>
+             <tensorRank>scalar</tensorRank>
+             <description>name of property</description>
+           </Parameter>
+         </Parameters>
+       </ParameterList>
+       <ReturnValue>
+         <type>any</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Member>
  
!     <Procedure name='ohRetrieveError'>
!       <description>retrieve error message associated with a given cell</description>
!       <alias>ObjHandler::ObjectHandlerXL::instance().retrieveError</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters/>
!       </ParameterList>
!       <ReturnValue>
!         <type>string</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohSetLogFile'>
!       <description>begin logging to named file</description>
!       <alias>ObjHandler::setLogFile</alias>
!       <supportedPlatforms>
!         <supportedPlatform>c</supportedPlatform>
!         <supportedPlatform>guile</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='logFileName'>
!             <type>string</type>
!             <tensorRank>scalar</tensorRank>
!             <description>path and name of log file</description>
!           </Parameter>
!           <Parameter name='logLevel' default='4'>
!             <type>long</type>
!             <tensorRank>scalar</tensorRank>
!             <description>threshold for log messages</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>string</type>
          <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohSetLogLevel'>
!       <description>set threshold for log messages</description>
!       <alias>ObjHandler::setLogLevel</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters>
!           <Parameter name='logLevel'>
!             <type>long</type>
!             <tensorRank>scalar</tensorRank>
!             <description>threshold for log messages</description>
!           </Parameter>
!         </Parameters>
!       </ParameterList>
!       <ReturnValue>
!         <type>void</type>
!         <tensorRank>scalar</tensorRank>
!         <description>returns new logging threshold</description>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohVersion'>
!       <description>returns the version number of ObjectHandler</description>
!       <alias>ObjHandler::version</alias>
!       <documentationOnly>true</documentationOnly>
!       <supportedPlatforms>
!         <supportedPlatform>excel</supportedPlatform>
!       </supportedPlatforms>
!       <ParameterList>
!         <Parameters/>
!       </ParameterList>
!       <ReturnValue>
!         <type>string</type>
!         <tensorRank>scalar</tensorRank>
!       </ReturnValue>
!     </Procedure>
! 
!     <Procedure name='ohSetConsole'>
!     <description>fork output to stdout</description>
!     <alias>ObjHandler::setConsole</alias>
!     <supportedPlatforms>
!       <supportedPlatform>c</supportedPlatform>
!       <supportedPlatform>guile</supportedPlatform>
!     </supportedPlatforms>
!     <ParameterList>
!     <Parameters>
!         <Parameter name='console'>
!             <type>int</type>
!             <tensorRank>scalar</tensorRank>
!             <description>1 (enable) / 0 (disable)</description>
!         </Parameter>
!         <Parameter name='logLevel' default='4'>
!             <type>long</type>
!             <tensorRank>scalar</tensorRank>
!             <description>threshold for log messages</description>
!         </Parameter>
!     </Parameters>
!     </ParameterList>
!     <ReturnValue>
!         <type>void</type>
!         <tensorRank>scalar</tensorRank>
!     </ReturnValue>
!     </Procedure>
  
  </Functions>