|
From: Eric E. <eri...@us...> - 2006-12-03 14:35:07
|
Update of /cvsroot/objecthandler/ObjectHandler/gensrc/metadata In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv27272/gensrc/metadata Added Files: demo.xml garbagecollection.xml logging.xml utilities.xml valueobjects.xml Removed Files: functions.xml Log Message: ohDemoObject() --- NEW FILE: valueobjects.xml --- <Category name='valueobjects'> <description>value objects</description> <displayName>Value Objects</displayName> <xlFunctionWizardCategory>ObjectHandler</xlFunctionWizardCategory> <includes/> <copyright> Copyright (C) 2004, 2005 Ferdinando Ametrano Copyright (C) 2004, 2005, 2006 Eric Ehlers Copyright (C) 2005, 2006 Plamen Neykov Copyright (C) 2004 StatPro Italia srl </copyright> <Functions> <Member name='ohPropertyNames' objectClass='Object'> <description>retrieve the property names of a given object</description> <libraryFunction>propertyNames</libraryFunction> <SupportedPlatforms> <Excel/> </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> <Excel/> </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> </Functions> </Category> --- NEW FILE: garbagecollection.xml --- <Category name='garbagecollection'> <description>garbage collection</description> <displayName>Garbage Collection</displayName> <xlFunctionWizardCategory>ObjectHandler</xlFunctionWizardCategory> <includes/> <copyright> Copyright (C) 2004, 2005 Ferdinando Ametrano Copyright (C) 2004, 2005, 2006 Eric Ehlers Copyright (C) 2005, 2006 Plamen Neykov Copyright (C) 2004 StatPro Italia srl </copyright> <Functions> <Procedure name='ohCollectGarbage'> <description>delete orphaned objects from repository</description> <alias>ObjHandler::ObjectHandlerXL::instance().collectGarbage</alias> <SupportedPlatforms> <Excel/> </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> <SupportedPlatforms> <Excel/> </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> <SupportedPlatforms> <Excel/> </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> </Functions> </Category> --- NEW FILE: utilities.xml --- <Category name='utilities'> <description>utilities</description> <displayName>Utilities</displayName> <xlFunctionWizardCategory>ObjectHandler</xlFunctionWizardCategory> <includes/> <copyright> Copyright (C) 2004, 2005 Ferdinando Ametrano Copyright (C) 2004, 2005, 2006 Eric Ehlers Copyright (C) 2005, 2006 Plamen Neykov Copyright (C) 2004 StatPro Italia srl </copyright> <Functions> <Procedure name='ohDependsOn' dependencyTrigger='false'> <description>forces a dependency between two functions and returns the update counter</description> <alias>ObjHandler::dependsOn</alias> <SupportedPlatforms> <Excel implementation='manual'/> </SupportedPlatforms> <ParameterList> <Parameters> <Parameter name='dummy0' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy1' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy2' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy3' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy4' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy5' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy6' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy7' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy8' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (ignored)</description> </Parameter> <Parameter name='dummy9' ignore='true'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>dummy range reference (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> <SupportedPlatforms> <Excel implementation='manual'/> </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> <Excel/> </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='ohObjectCount'> <description>#/objects in repository</description> <alias>ObjHandler::ObjectHandlerXL::instance().objectCount</alias> <SupportedPlatforms> <Excel/> </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> <SupportedPlatforms> <Excel implementation='manual'/> </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' dependencyTrigger='False'> <description>Extract the ith number from a whitespace-delimited list of fields</description> <alias>ObjHandler::parseField</alias> <SupportedPlatforms> <Excel implementation='manual'/> </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> <Parameter name='dataType' default='"NUMBER"'> <type>string</type> <tensorRank>scalar</tensorRank> <description>expected datatype - NUMBER or STRING (default = NUMBER)</description> </Parameter> <Parameter name='delim' default='"[:space:]"'> <type>string</type> <tensorRank>scalar</tensorRank> <description>delimiter (default = whitespace)</description> </Parameter> </Parameters> </ParameterList> <ReturnValue> <type>any</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> <Procedure name='ohRetrieveError'> <description>retrieve error message associated with a given range</description> <alias>ObjHandler::ObjectHandlerXL::instance().retrieveError</alias> <SupportedPlatforms> <Excel/> </SupportedPlatforms> <ParameterList> <Parameters> <Parameter name='range'> <type>reference</type> <tensorRank>scalar</tensorRank> <description>range to query</description> </Parameter> </Parameters> </ParameterList> <ReturnValue> <type>string</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> <Procedure name='ohVersion'> <description>returns the version number of ObjectHandler</description> <alias>ObjHandler::version</alias> <SupportedPlatforms> <Excel/> </SupportedPlatforms> <ParameterList> <Parameters/> </ParameterList> <ReturnValue> <type>string</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Procedure> </Functions> </Category> --- NEW FILE: demo.xml --- <Category name='demo'> <description>demo</description> <displayName>Demo</displayName> <xlFunctionWizardCategory>ObjectHandler</xlFunctionWizardCategory> <includes> <include>oh/demoobject.hpp</include> </includes> <copyright> Copyright (C) 2006 Eric Ehlers </copyright> <Functions> <Constructor name='ohDemoObject'> <libraryFunction>DemoObject</libraryFunction> <SupportedPlatforms> <Excel/> </SupportedPlatforms> <ParameterList> <Parameters> <Parameter name='stringParam'> <type>string</type> <tensorRank>scalar</tensorRank> <description>string parameter</description> </Parameter> <Parameter name='longParam' defaultValue='42'> <type>long</type> <tensorRank>scalar</tensorRank> <description>long parameter</description> </Parameter> </Parameters> </ParameterList> </Constructor> <Member name='ohDemoStringParam' objectClass='DemoObject'> <description>retrieve value of parameter stringParam from object of class DemoObject</description> <libraryFunction>stringParam</libraryFunction> <SupportedPlatforms> <Excel/> </SupportedPlatforms> <ParameterList> <Parameters/> </ParameterList> <ReturnValue> <type>string</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Member> <Member name='ohDemoSetStringParam' objectClass='DemoObject'> <description>set value of parameter stringParam for object of class DemoObject</description> <libraryFunction>setStringParam</libraryFunction> <SupportedPlatforms> <Excel/> </SupportedPlatforms> <ParameterList> <Parameters> <Parameter name='stringParam'> <type>string</type> <tensorRank>scalar</tensorRank> <description>new value for string parameter</description> </Parameter> </Parameters> </ParameterList> <ReturnValue> <type>string</type> <tensorRank>scalar</tensorRank> </ReturnValue> </Member> </Functions> </Category> --- functions.xml DELETED --- --- NEW FILE: logging.xml --- <Category name='logging'> <description>logging functions</description> <displayName>Logging Functions</displayName> <xlFunctionWizardCategory>ObjectHandler</xlFunctionWizardCategory> <includes/> <copyright> Copyright (C) 2004, 2005 Ferdinando Ametrano Copyright (C) 2004, 2005, 2006 Eric Ehlers Copyright (C) 2005, 2006 Plamen Neykov Copyright (C) 2004 StatPro Italia srl </copyright> <Functions> <Procedure name='ohLogAllObjects'> <description>write all object descriptions to log file</description> <alias>ObjHandler::logAllObjects</alias> <SupportedPlatforms> <Excel/> </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> <Excel/> </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> <Excel/> </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='ohSetLogFile'> <description>begin logging to named file</description> <alias>ObjHandler::setLogFile</alias> <SupportedPlatforms> <Excel/> </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> <SupportedPlatforms> <Excel/> </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> </Functions> </Category> |
