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

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

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

Added Files:
	functions.xml 
Log Message:
autogenerate ObjectHandler code

--- NEW FILE: functions.xml ---
<Category name='functions'>
<description>ObjectHandler functions</description>
<displayName>ObjectHandler</displayName>

<Functions>

<Procedure name='ohVersion'>
<description>returns the version number of ObjectHandler</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::version</alias>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters/>
</ParameterList>
<ReturnValue>
  <type>string</type>
  <tensorRank>scalar</tensorRank>
  <description>ObjectHandler version number</description>
</ReturnValue>
</Procedure>

<Procedure name='ohObjectCount'>
<description>#/objects in repository</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::ObjectHandler::instance().objectCount</alias>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters/>
</ParameterList>
<ReturnValue>
    <type>long</type>
    <tensorRank>scalar</tensorRank>
    <description>object count</description>
</ReturnValue>
</Procedure>

<Procedure name='ohListInstanceNames'>
<description>list instance names of objects in repository</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::ObjectHandler::instance().listInstanceNames</alias>
<functionCategory>ObjectHandler</functionCategory>
<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>
    <description>list of instance names matching regex</description>
</ReturnValue>
</Procedure>

<Member name='ohPropertyNames' objectClass='Object'>
<description>retrieve the property names of a given object</description>
<!--platforms>CGO</platforms-->
<libraryFunction>propertyNames</libraryFunction>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
  <Parameters/>
</ParameterList>
<ReturnValue>
    <type>string</type>
    <tensorRank>vector</tensorRank>
    <description>list of property names for queried object</description>
</ReturnValue>
</Member>

<Member name='ohPropertyValue' objectClass='Object'>
<description>retrieve the value of a named property</description>
<!--platforms>CGO</platforms-->
<libraryFunction>propertyValue</libraryFunction>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters>
    <Parameter name='fieldName'>
        <type>string</type>
        <tensorRank>scalar</tensorRank>
        <description>name of property</description>
    </Parameter>
    <Parameter name='trigger' ignore='true'>
        <type>any</type>
        <tensorRank>scalar</tensorRank>
        <description>dependency tracking trigger</description>
    </Parameter>
</Parameters>
</ParameterList>
<ReturnValue>
    <type>any</type>
    <tensorRank>scalar</tensorRank>
    <description>value of named field</description>
</ReturnValue>
</Member>

<Procedure name='ohDeleteObject'>
<description>delete object from repository</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::ObjectHandler::instance().deleteObject</alias>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters>
    <Parameter name='instanceName'>
        <type>string</type>
        <tensorRank>scalar</tensorRank>
        <description>instance name of object to be deleted</description>
    </Parameter>
</Parameters>
</ParameterList>
<ReturnValue>
    <type>void</type>
    <tensorRank>scalar</tensorRank>
    <description>success/failure</description>
</ReturnValue>
</Procedure>

<Procedure name='ohDeleteAllObjects'>
<description>delete all objects from repository</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::ObjectHandler::instance().deleteAllObjects</alias>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters/>
</ParameterList>
<ReturnValue>
    <type>void</type>
    <tensorRank>scalar</tensorRank>
    <description>success/failure</description>
</ReturnValue>
</Procedure>

<Procedure name='ohDependsOn'>
<description>force a dependency between two functions</description>
<!--platforms>D</platforms-->
<functionCategory>ObjectHandler</functionCategory>
<alias>ObjHandler::dependsOn</alias>
<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>
    <description>update count</description>
</ReturnValue>
</Procedure>

<Procedure name='ohSetLogFile'>
<description>begin logging to named file</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::setLogFile</alias>
<functionCategory>ObjectHandler</functionCategory>
<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>
    <description>name of logfile</description>
</ReturnValue>
</Procedure>

<Procedure name='ohSetLogLevel'>
<description>set threshold for log messages</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::setLogLevel</alias>
<functionCategory>ObjectHandler</functionCategory>
<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='ohLogMessage'>
<description>log a message</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::logMessage</alias>
<functionCategory>ObjectHandler</functionCategory>
<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>
    <description>message logged</description>
</ReturnValue>
</Procedure>

<Procedure name='ohLogObject'>
<description>write object description to log file</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::logObject</alias>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters>
    <Parameter name='instanceName'>
        <type>string</type>
        <tensorRank>scalar</tensorRank>
        <description>instance name of object to be logged</description>
    </Parameter>
</Parameters>
</ParameterList>
<ReturnValue>
    <type>void</type>
    <tensorRank>scalar</tensorRank>
    <description>success/failure</description>
</ReturnValue>
</Procedure>

<Procedure name='ohLogAllObjects'>
<description>write all object descriptions to log file</description>
<!--platforms>CGO</platforms-->
<alias>ObjHandler::logAllObjects</alias>
<functionCategory>ObjectHandler</functionCategory>
<ParameterList>
<Parameters/>
</ParameterList>
<ReturnValue>
    <type>void</type>
    <tensorRank>scalar</tensorRank>
    <description>success/failure</description>
</ReturnValue>
</Procedure>

<!--Procedure name='ohSetConsole'>
<description>fork output to stdout</description>
<platforms>CG</platforms>
<alias>ObjHandler::setConsole</alias>
<functionCategory>ObjectHandler</functionCategory>
<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>
    <description>success/failure</description>
</ReturnValue>
</Procedure-->

<!--Procedure name='ohGetGcEnabled'>
<description>get value of ObjectHandler garbage collection flag</description>
<platforms>D</platforms>
<ParameterList>
<Parameters/>
</ParameterList>
<ReturnValue>
    <type>bool</type>
    <tensorRank>scalar</tensorRank>
    <description>success/failure</description>
</ReturnValue>
</Procedure>

<Procedure name='ohSetGcEnabled'>
<description>set value of ObjectHandler garbage collection flag</description>
<platforms>D</platforms>
<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>
    <description>success/failure</description>
</ReturnValue>
</Procedure-->

<Procedure name='ohCallGC'>
<description>delete orphaned objects from repository</description>
<!--platforms>D</platforms-->
<functionCategory>ObjectHandler</functionCategory>
<alias>ObjHandler::ObjectHandler::instance().collectGarbage</alias>
<ParameterList>
<Parameters/>
</ParameterList>
<ReturnValue>
    <type>void</type>
    <tensorRank>scalar</tensorRank>
    <description>success/failure</description>
</ReturnValue>
</Procedure>

</Functions>
</Category>