Solutions Areas
   Manufacturing
   Oil & Gas
   Finance
   Health Services
 Government
   Maritime
Site Search

Community
    FAQ
 Contact
 IDEF
 Sales

Documentation

DDML 3.0 schema (xsd) file:

http://www.kbsi.com/DDML/DDML30.xsd

(Right-click on the link and select Save Target As... from the menu).

For the DDML 3.0 schema file to validate, you will need to put the following schemas in the same directory as the DDML30.xsd file:

bullet xml.xsd
bullet

SVG.xsd

bullet xlink.xsd
bullet mathml2.xsd
bullet mathml2-qname-1.mod.xsd

An easy-to-view web page format of the schema can be found here.

top
casestudies
bottom
top
title
DDTF: Data Display Translation Framework
arrowdown
bottom
DDML Development
Past DDML Versions (2.0)

If you have any comments or questions, please send them to JLHamilton@kbsi.com.

Notes

Colors in DDML are encoded in a 24-bit integer as 0xRRGGBB

DDML does not have its own coordinate system. Instead, each model must specify its coordinate system with the minX, minY, maxX, maxY, xDirection, and yDirection elements.

DDML Elements and Definitions

D E F G H I M O P R S T V X

barchart

  A display object that shows one or more variables as vertical or horizontal bars whose lengths correspond to the values.
button
  A display object that consists of an image or icon that, when clicked, can assign a value to a variable.
data_source
  A pool-level data source that is available for use by any of the variables in the variable pool.
data_source_pool
  Contains data_source child elements representing all of the data sources used by the various objects in the DDML file. Information about all data sources (files, db connections, etc.) is kept in the data source pool.
ddml
  The top-level element in a DDML document.
dial
  A display object that consists of a circular or arc value axis and some sort of marker or needle that points to the current value along this axis. Example: a dial or a compass.
display_parameters
  The parent element of a group of param elements that specify all of the custom parameters for a particular display object.
dynamics
  A set of variable_uses and rules used to define the dynamic behavior of a display object. The type attribute describes the dynamic behavior while the variable_use and rules child elements define how variable values affect that behavior. A type of 'builtin' is used for display objects that have implicit dynamic behavior, such as charts and sliders.
else
  Part of a rule, specifies what to do if the criteria specified in the if element are false. The else element can be the parent of one or more additional rules, or can just specify a value or variable reference.
expr
  Defines a variable as a function of other variables. Expr elements can be nested to create more complex expressions.

Example: 2*(var1)^2 + 2*sin(var2)^2 would be represented as:

<variable id="var3" data_source_ref="ds2" name="Var:3">
    <expr coef="2" var_ref="var1" power="2" />
    <expr coef="2" oper="SIN" power="2">
          <expr var_ref="var2" />
    </expr>
</variable>
frequencyplot
  A display object that is a chart in the frequency domain.
frequencyresponse
  A display object that is a graph consisting of two value axes (frequency and magnitude) plotted against a single frequency axis.
graphics
  The top-level element for a group of svg elements (primitive shapes such as lines, circles, and rectangles).
grid
  A table. The grid element is used to group several display objects (including other grids) together in a tabular layout.
hud
  A display object that resembles a typical aircraft heads-up display that consists of three vertical axes (typically used for velocity, pitch, and altitude) and one horizontal axis (typically for heading). The center vertical axis rotates according to a fifth variable (typically roll). The variable_uses in the dynamics section are applied in this order: center vertical axis rotation (roll), center vertical axis (pitch), horizontal axis (heading), right vertical axis (altitude), left vertical axis (velocity).
if
  Part of a rule, specifies the first and/or last values in a desired range (inclusive or exclusive), or a single value to compare for inequality.
model
  A single screen or page of display objects.
object
  A generic display object. An 'object' can be any display object not specified in the DDML definition, or can be used as the top-level element in a group of sub-objects.
param
  Used to specify any parameter of a DDML element that is not already specified in the element's attribute list. These are commonly referred to as "custom parameters" and are mostly used for vendor-specific information.
piechart
  A circular display object that shows the values of multiple variables as a percentage slice of their sum.
project
  A collection of models.
radialchart
  A display object that represents variable values as distances outward from a central point. A radial chart consists of two axes: a linear value axis and a circular axis. The circular axis can be either a time axis or a value axis. The type of the circular axis is controlled by the circularAxisType attribute, which can have a value of either 'time' or 'firstVar'. If the value is 'firstVar', then the circular axis is a value axis whose value is controlled by the first variable_use element in the radialchart's dynamics section.
rule
  Specifies a change in an attribute (e.g., color, visibility) when a variable reaches a certain value or range of values. The ranges of values and resulting attribute values are specified with if, then, and else child elements.
rules
  The parent element of a group of rule elements.
slider
  A display object that consists of some kind of indicator or icon that slides along a single value axis. A slider can be vertical or horizontal. Example: A 'gauge' in Range View or a 'fader' in Data Views.
stripchart
  A display object that is essentially a line graph that plots values vs. time along a scrolling "paper" grid. A stripchart can be vertical or horizontal, and can scroll in any of the four directions (up, down, left, right). This is controlled by the scrollDirection attribute. The scrollDirection attribute refers to the direction that the paper or background scrolls. For example, in a DataViews horizontal strip chart, the paper scrolls to the left while new values are plotted at the right edge of the graph. Thus, the scrollDirection is 'left'.
textual
  A display object used for representing text and labels, including both static and dynamic text (such as annunciators). If the text is dynamic, the valuePosition attribute specifies where the dynamic value is in relation to the static label. Use valuePosition='center' if there is no label. The valueFormat attribute is a C printf-style format string that specifies the format of the dynamic value. For example valueFormat="%4.2f" indicates that the value should be output as a floating-point value with a maximum width of 4 and with 2 decimal places.
then
  Part of a rule, the then element specifies the value to set the attribute to if the criteria specified in the if element is true. The then element can specify either the desired value, or a reference to a variable containing the desired value.
variable
  A pool-level data variable that is available for use by any of the display objects in the ddml file.
variable pool
  Contains variable child elements representing all of the variables used by the various display objects in the DDML file.
variable use
  A child of the dynamics element, variable_use is used to specify which variable from the variable pool is used. The pool_ref attribute must refer to the id attribute of a variable element from the variable_pool.
xychart
  A display object that is a line or xy scatter plot of variables in the yaxis vs. other variables in the x axis. The x,y variable pairs are specified with the xyPairs attribute with the form xyPairs="x1,y1 x2,y2 x3,y3". Each x1,y1,x2 etc. value must be a reference to the id attribute of a variable_use element in the xychart's dynamics section.

 

 
Knowledge Based Systems, Inc.
Corporate Headquarters:  1408 University Dr. East  College Station, TX  77840
Phone:979.260.5274  bullet.gif (81 bytes)   Fax:979.260.1965
© 2007 KBSI. All rights reserved.   Legal Notices.    Questions? Contact webmaster@kbsi.com.