The lcgdict Selection File

Seal Project | Project Portal

$Date: 2004/10/19 09:20:36 $

  • Syntax description
  • Description of elements and attributes
  • Syntax Description

    The pseudo syntax description can be seen in the table below.

    <lcgdict>
    	[<selection>]
        	<class [name="classname"] [pattern="wildname"] 
                   [file_name="filename"] [file_pattern="wildname"] 
                   [id="xxxx"] [type="vector"]/>
            <class name="classname" >
            	<field name="m_transient" transient="true"/>
                <field name="m_anothertransient" transient="true"/>
                	<properties prop1="value1" [prop2="value2"]/>
            </class>
            <function [name="funcname"] [pattern="wildname"] />
        [</selection>]
        <exclusion>
        	<class [name="classname"] [pattern="wildname"] />
            	<method name="unwanted" />
            </class>
    	...
    </lcgdict>

    Description of elements and attributes

    <lcgdict>

    Sub elements: <selection> <exclusion> <class> <function>

    Attributes: none

    The root element of the xml file. It has to be present.

     

    <selection>

    Sub elements: <class> <function>

    Attributes: none

    The selection element is only mandatory if the <exclusion> element is used in the same file. Otherwise all sub-elements of <lcgdict> are supposed to be included in the dictionary.

     

    <exclusion>

    Sub elements: <class> <function>

    Attributes: none

    If a selection element is present it is also possible to exclude types following the same patterns as for selection

     

    <class>

    Sub elements: <field> <properties> <method>

    Attributes:

    Attribute name Description
    name The exact name of the class to be filtered
    pattern A pattern matching a set of classes
    file_name The exact file name to be filtered. All classes contained in the file will be selected
    file_pattern A pattern matching a set of files
    id The class ID (used for POOL persistency)
    type The class type (used for POOL persistency)

    All classes matching the patterns or names in the attributes will be selected. The "name", "pattern", "file_name" and "file_pattern" attributes are mutual exclusive.

     

    <function>

    Sub elements: none

    Attributes:

    Attribute name Description
    name The exact name of the function
    pattern A pattern matching a set of functions

    All function matching the attributes of the function element will be selected and dictionaries will be created for them. The "name" and "pattern" attributes are mutual exclusive.

     

    <field>

    Sub elements: none

    Attributes:

    Attribute name Description
    name The exact name of the field
    transient If set to true a property (transient/true) will be set for this member (used for POOL persistency)

    The <field> element is mainly used for POOL persistency to mark if some of the data members of a class shall be skipped when the class is written to a persistent medium

     

    <method>

    Sub elements: none

    Attributes:

    Attribute name Description
    name The name of the method to be excluded

    The <method> element is used to exclude the dictionary generation from classes which match the given attributes.


    Contact: Stefan Roiser