1. Introduction

ParamML documents are created in the form of a specially formatted text file following XML convention.

Here is what an empty ParamML document would look like:

<!‐‐ this is where the project definitions go ‐‐>

</O>

Notice the second line in green text. This is how comments are added in an XML file. Anything between < !‐‐ and ‐ ‐> are taken as comments and completely ignored by OpenBrIM. Anything written as comment into the ParamML document is for author's own purpose. Neither the app nor the end user can see the comments placed inside ParamML documents.

While not visible to the end user, the organization and the tidiness of the ParamML document is very important. Never use a word processor to develop the XML file. Instead, use XML editors. A recommended application is notepad++ (https://notepad-plus-plus.org/) -- it is a simple text editor. Make sure to set the language to XML (from the menu, Language > XML).

Objects and Parameters

Objects, each defined by its own parameters, make up a ParamML document.

Objects are represented by O tags. Parameters are defined using P tags. Every object and parameter has a starting and a closing tag:

For a Group Object, <O N="Group1" T="Group"> is the starting tag and </O> is the closing tag.

For a Parameter named "height", <P N="height" V="10"> is the starting tag and </P> is the closing tag.

Anything in between the start and end tags of an object or parameter is considered to be inside the object or parameter and should be indented one tab for organizational purposes. If the tag will not contain another tag in it, the following shortcuts can be used:

This documentation will discuss the different types of objects and parameters used to define structure property, geometry, analytical model, design procedure, etc.

Page updated

Report abuse