4 Markup Language Syntax

In this section we describe all defined tags and their attributes.

4.1 <bankdef>

The top level tag. All BDML documents begin with <bankdef> and end with </bankdef>.

Parent tag: none.

Child tags: <struct>, <bank>.

4.2 <struct>

This tag defines a structure in bankdef.h.

Parent tag: <bankdef>.

Child tags: <member>.

Attributes are:

name The name of the structure.

comment (optional) A comment to appear in bankdef.h associated with the structure as a whole.

4.3 <member>

This tag describes a member of a structure.

Parent tag: <structure>.

Child tags: none.

Attributes are:

name The name of the member variable.

type The data type of the member variable, e. g., int, float, rawhit_t, etc.

comment (optional) A comment specific to this variable.

4.4 <bank>

Describes a PrimEx bank. Each bank tag generates a structure definition in bankdef.h and in the appropriate line of bank initialization code in bankinit.cc.

Parent tag: <bankdef>.

Child tag: <column>.

Attributes are:

name The name of the bank.

comment (optional) Comment associated with the bank as a whole.

typedef (optional) If this attribute is specified, the bank is based entirely on a previously defined structure, just with a different name. The value of the attribute is the name of the type of the defining structure.

size (required if typedef specified) The name of the structure which defines a row of the bank on which the current bank is based. Used to specify the size of a bank row for initialization.

bankflag (required if typedef specified) Specifies the bankflag to be used during initialization.

4.5 <column>

Specifies one column of a row of bank.

Parent tag: <bank>.

Child tags: none.

Attributes are:

name The name of the column.

type The data type of the column, e. g., int, float, rawhit_t, etc.

comment (optional) A comment specific to this column.

4.6 <CVSID>

Parent tag: <bankdef>.

A convenient place to put version control information, RCS keywords in particular.

Child tags: none.

No attributes.