Name

parameter — A generic parameter of a simple type.

Synopsis

Content Model

 parameter ::= (#PCDATA)

Description

The parameter element describes a value of a simple type, such as integer, 3-dimensional vector. The attribute names follow those of DocBook parameter.

Processing expectations

Initialize a value of the object the parameter is mapped on by #PCDATA.

Note

The valid name and condition depends on the parent. When the src attribute is given, an application is expected to use an external source.

Children

NONE

Attributes

id

Optional, ID type.

name

Required, the name of an object to which the parameter is mapped.

condition

Optional, the constraint on the parameter, e.g., its unit.

datatype

Optional, type of the object within an application.

src

Optional, an external file that contains the data.

role

Reserved to refine the parameter.

Examples

The parameter element is used to set the scale of a FCC unitcell to 5.432 A.

 <unitcell>
    <parameter name="scale" condition="AA">5.432 </parameter>
    <parameter name="lattice">  
       1.0 0.0 0.0 
       0.0 1.0 0.0 
       0.0 0.0 1.0 
    </parameter>
    <parameter name="bconds"> p p p </parameter>
 </unitcell>