[ObjectHandler-cvs] ObjectHandler/gensrc/metadata ohutils.xml, NONE, 1.1 utilities.xml, 1.1, NONE

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

Update of /cvsroot/objecthandler/ObjectHandler/gensrc/metadata
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv3145/gensrc/metadata

Added Files:
	ohutils.xml 
Removed Files:
	utilities.xml 
Log Message:
rename ohParseFields() to ohSplit() and modify behavior:
- no need to specify "DOUBLE/STRING" datatype
- if index omitted, all fields returned as array

--- utilities.xml DELETED ---

--- NEW FILE: ohutils.xml ---
<Category name='ohutils'>
  <description>objecthandler utilities</description>
  <displayName>ObjectHandler 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='ohSplit' 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='delim' default='"[:space:]"'>
            <type>string</type>
            <tensorRank>scalar</tensorRank>
            <description>delimiter (default = whitespace)</description>
          </Parameter>
          <Parameter name='index' default='-1'>
            <type>long</type>
            <tensorRank>scalar</tensorRank>
            <description>index (1-based) of desired field - if omotted, all fields returned as arrray</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>