[ObjectHandler-cvs] ObjectHandler/gensrc/metadata functions.xml, 1.19, 1.20
Brought to you by:
ericehlers,
nando
From: Eric E. <eri...@us...> - 2006-10-04 13:24:38
|
Update of /cvsroot/objecthandler/ObjectHandler/gensrc/metadata In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv11486/metadata Modified Files: functions.xml Log Message: remove redundant metadata Index: functions.xml =================================================================== RCS file: /cvsroot/objecthandler/ObjectHandler/gensrc/metadata/functions.xml,v retrieving revision 1.19 retrieving revision 1.20 diff -C2 -d -r1.19 -r1.20 *** functions.xml 3 Oct 2006 09:32:37 -0000 1.19 --- functions.xml 4 Oct 2006 13:24:36 -0000 1.20 *************** *** 13,49 **** <Functions> ! <Procedure name='ohVersion'> ! <description>returns the version number of ObjectHandler</description> ! <alias>ObjHandler::version</alias> ! <supportedPlatforms> ! <supportedPlatform>excel</supportedPlatform> ! </supportedPlatforms> ! <ParameterList> ! <Parameters/> ! </ParameterList> ! <ReturnValue> ! <type>string</type> ! <tensorRank>scalar</tensorRank> ! </ReturnValue> ! </Procedure> ! ! <Procedure name='ohObjectCount'> ! <description>#/objects in repository</description> ! <alias>ObjHandler::ObjectHandlerXL::instance().objectCount</alias> ! <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> --- 13,19 ---- <Functions> ! <Procedure name='ohCallGC'> ! <description>delete orphaned objects from repository</description> ! <alias>ObjHandler::ObjectHandlerXL::instance().collectGarbage</alias> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 51,85 **** <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> ! <Member name='ohPropertyNames' objectClass='Object'> ! <description>retrieve the property names of a given object</description> ! <libraryFunction>propertyNames</libraryFunction> ! <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> --- 21,40 ---- <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 87,102 **** <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='ohDeleteObject'> --- 42,57 ---- <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'> *************** *** 121,145 **** </Procedure> - <Procedure name='ohDeleteAllObjects'> - <description>delete all objects from repository</description> - <alias>ObjHandler::ObjectHandlerXL::instance().deleteAllObjects</alias> - <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='ohDependsOn'> <description>forces a dependency between two functions and returns the update counter</description> --- 76,79 ---- *************** *** 209,215 **** </Procedure> ! <Procedure name='ohSetLogFile'> ! <description>begin logging to named file</description> ! <alias>ObjHandler::setLogFile</alias> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> --- 143,165 ---- </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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 217,229 **** <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> --- 167,174 ---- <ParameterList> <Parameters> ! <Parameter name='regex'> <type>string</type> <tensorRank>scalar</tensorRank> ! <description>optional matching pattern in UNIX format (wildcard is .*)</description> </Parameter> </Parameters> *************** *** 231,257 **** <ReturnValue> <type>string</type> ! <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> ! <Procedure name='ohSetLogLevel'> ! <description>set threshold for log messages</description> ! <alias>ObjHandler::setLogLevel</alias> <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> --- 176,195 ---- <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> </supportedPlatforms> <ParameterList> ! <Parameters/> </ParameterList> <ReturnValue> <type>void</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> *************** *** 280,284 **** <type>void</type> <tensorRank>scalar</tensorRank> - <description>message logged</description> </ReturnValue> </Procedure> --- 218,221 ---- *************** *** 305,311 **** </Procedure> ! <Procedure name='ohLogAllObjects'> ! <description>write all object descriptions to log file</description> ! <alias>ObjHandler::logAllObjects</alias> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> --- 242,248 ---- </Procedure> ! <Procedure name='ohObjectCount'> ! <description>#/objects in repository</description> ! <alias>ObjHandler::ObjectHandlerXL::instance().objectCount</alias> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 315,386 **** </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>excel</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--> ! <!--Procedure name='ohGetGcEnabled'> ! <description>get value of ObjectHandler garbage collection flag</description> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> </supportedPlatforms> ! <ParameterList> ! <Parameters/> ! </ParameterList> ! <ReturnValue> ! <type>bool</type> ! <tensorRank>scalar</tensorRank> ! </ReturnValue> ! </Procedure> ! <Procedure name='ohSetGcEnabled'> ! <description>set value of ObjectHandler garbage collection flag</description> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> </supportedPlatforms> ! <ParameterList> ! <Parameters> ! <Parameter name='enableGarbageCollection'> ! <type>bool</type> ! <tensorRank>scalar</tensorRank> ! <description>true (enable) / false (disable)</description> ! </Parameter> ! </Parameters> ! </ParameterList> ! <ReturnValue> ! <type>bool</type> ! <tensorRank>scalar</tensorRank> ! </ReturnValue> ! </Procedure--> ! <Procedure name='ohCallGC'> ! <description>delete orphaned objects from repository</description> ! <alias>ObjHandler::ObjectHandlerXL::instance().collectGarbage</alias> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> --- 252,327 ---- </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> <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 388,403 **** <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='ohRetrieveError'> --- 329,344 ---- <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'> *************** *** 416,423 **** </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> --- 357,363 ---- </Procedure> ! <Procedure name='ohSetLogFile'> ! <description>begin logging to named file</description> ! <alias>ObjHandler::setLogFile</alias> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 425,445 **** <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> --- 365,389 ---- <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 447,472 **** <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> ! <Procedure name='ohFunctionCount'> ! <description>returns the number of functions in this addin</description> <alias>ObjHandler::version</alias> - <documentationOnly>true</documentationOnly> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> --- 391,411 ---- <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> <supportedPlatforms> <supportedPlatform>excel</supportedPlatform> *************** *** 476,484 **** </ParameterList> <ReturnValue> ! <type>long</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> ! </Functions> </Category> --- 415,424 ---- </ParameterList> <ReturnValue> ! <type>string</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> ! </Functions> </Category> + |